freesrp_sink_c.h
Go to the documentation of this file.
/* -*- c++ -*- */
/*
* Copyright 2015 Lukas Lao Beyer
* Copyright 2013 Dimitri Stolnikov <horiz0n@gmx.net>
*
* 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_FREESRP_SINK_C_H
#define INCLUDED_FREESRP_SINK_C_H
#include <gnuradio/thread/thread.h>
#include <gnuradio/block.h>
#include <gnuradio/sync_block.h>
#include "osmosdr/ranges.h"
#include "sink_iface.h"
#include "freesrp_common.h"
#include "readerwriterqueue/readerwriterqueue.h"
#include <mutex>
#include <condition_variable>
#include <freesrp.hpp>
class freesrp_sink_c;
/*
* We use boost::shared_ptr's instead of raw pointers for all access
* to gr_blocks (and many other data structures). The shared_ptr gets
* us transparent reference counting, which greatly simplifies storage
* management issues. This is especially helpful in our hybrid
* C++ / Python system.
*
* See http://www.boost.org/libs/smart_ptr/smart_ptr.htm
*
* As a convention, the _sptr suffix indicates a boost::shared_ptr
*/
typedef boost::shared_ptr<freesrp_sink_c> freesrp_sink_c_sptr;
/*!
* \brief Return a shared_ptr to a new instance of freesrp_sink_c.
*
* To avoid accidental use of raw pointers, freesrp_sink_c's
* constructor is private. make_freesrp_sink_c is the public
* interface for creating new instances.
*/
freesrp_sink_c_sptr make_freesrp_sink_c (const std::string & args = "");
class freesrp_sink_c :
public gr::sync_block,
public sink_iface,
public freesrp_common
{
private:
// The friend declaration allows freesrp_make_sink_c to
// access the private constructor.
friend freesrp_sink_c_sptr make_freesrp_sink_c (const std::string & args);
freesrp_sink_c (const std::string & args); // private constructor
public:
// From freesrp_common:
static std::vector<std::string> get_devices() { return freesrp_common::get_devices(); };
size_t get_num_channels( void ) { return freesrp_common::get_num_channels(); }
osmosdr::meta_range_t get_sample_rates( void ) { return freesrp_common::get_sample_rates(); }
osmosdr::freq_range_t get_freq_range( size_t chan = 0 ) { return freesrp_common::get_freq_range(chan); }
osmosdr::freq_range_t get_bandwidth_range( size_t chan = 0 ) { return freesrp_common::get_bandwidth_range(chan); }
double set_freq_corr( double ppm, size_t chan = 0 ) { return freesrp_common::set_freq_corr(ppm, chan); }
double get_freq_corr( size_t chan = 0 ) { return freesrp_common::get_freq_corr(chan); }
bool start();
bool stop();
int work( int noutput_items,
gr_vector_const_void_star &input_items,
gr_vector_void_star &output_items );
double set_sample_rate( double rate );
double get_sample_rate( void );
double set_center_freq( double freq, size_t chan = 0 );
double get_center_freq( size_t chan = 0 );
std::vector<std::string> get_gain_names( size_t chan = 0 );
osmosdr::gain_range_t get_gain_range( size_t chan = 0 );
osmosdr::gain_range_t get_gain_range( const std::string & name, size_t chan = 0 );
//TODO: implement this: bool set_gain_mode( bool automatic, size_t chan = 0 );
//TODO: implement this: bool get_gain_mode( size_t chan = 0 );
double set_gain( double gain, size_t chan = 0 );
double set_gain( double gain, const std::string & name, size_t chan = 0 );
double get_gain( size_t chan = 0 );
double get_gain( const std::string & name, size_t chan = 0 );
double set_bb_gain( double gain, size_t chan = 0 );
std::vector< std::string > get_antennas( size_t chan = 0 );
std::string set_antenna( const std::string & antenna, size_t chan = 0 );
std::string get_antenna( size_t chan = 0 );
double set_bandwidth( double bandwidth, size_t chan = 0 );
double get_bandwidth( size_t chan = 0 );
private:
void freesrp_tx_callback(std::vector<::FreeSRP::sample> &samples);
bool _running = false;
std::mutex _buf_mut{};
std::condition_variable _buf_cond{};
size_t _buf_available_space = FREESRP_RX_TX_QUEUE_SIZE;
moodycamel::ReaderWriterQueue<::FreeSRP::sample> _buf_queue{FREESRP_RX_TX_QUEUE_SIZE};
};
#endif /* INCLUDED_FREESRP_SINK_C_H */
freesrp_common
Definition freesrp_common.h:13
freesrp_common::get_freq_corr
double get_freq_corr(size_t chan=0)
freesrp_common::get_devices
static std::vector< std::string > get_devices()
freesrp_common::get_bandwidth_range
osmosdr::freq_range_t get_bandwidth_range(size_t chan=0)
freesrp_common::set_freq_corr
double set_freq_corr(double ppm, size_t chan=0)
freesrp_common::get_freq_range
osmosdr::freq_range_t get_freq_range(size_t chan=0)
freesrp_common::get_num_channels
size_t get_num_channels(void)
freesrp_common::get_sample_rates
osmosdr::meta_range_t get_sample_rates(void)
freesrp_sink_c
Definition freesrp_sink_c.h:67
freesrp_sink_c::set_sample_rate
double set_sample_rate(double rate)
freesrp_sink_c::get_bandwidth_range
osmosdr::freq_range_t get_bandwidth_range(size_t chan=0)
Definition freesrp_sink_c.h:82
freesrp_sink_c::get_devices
static std::vector< std::string > get_devices()
Definition freesrp_sink_c.h:78
freesrp_sink_c::get_num_channels
size_t get_num_channels(void)
Definition freesrp_sink_c.h:79
freesrp_sink_c::get_gain
double get_gain(const std::string &name, size_t chan=0)
freesrp_sink_c::get_center_freq
double get_center_freq(size_t chan=0)
freesrp_sink_c::get_freq_range
osmosdr::freq_range_t get_freq_range(size_t chan=0)
Definition freesrp_sink_c.h:81
freesrp_sink_c::stop
bool stop()
freesrp_sink_c::get_sample_rate
double get_sample_rate(void)
freesrp_sink_c::set_gain
double set_gain(double gain, size_t chan=0)
freesrp_sink_c::get_antennas
std::vector< std::string > get_antennas(size_t chan=0)
freesrp_sink_c::set_bandwidth
double set_bandwidth(double bandwidth, size_t chan=0)
freesrp_sink_c::get_gain_range
osmosdr::gain_range_t get_gain_range(const std::string &name, size_t chan=0)
freesrp_sink_c::set_freq_corr
double set_freq_corr(double ppm, size_t chan=0)
Definition freesrp_sink_c.h:83
freesrp_sink_c::make_freesrp_sink_c
friend freesrp_sink_c_sptr make_freesrp_sink_c(const std::string &args)
Return a shared_ptr to a new instance of freesrp_sink_c.
freesrp_sink_c::set_center_freq
double set_center_freq(double freq, size_t chan=0)
freesrp_sink_c::get_freq_corr
double get_freq_corr(size_t chan=0)
Definition freesrp_sink_c.h:84
freesrp_sink_c::get_gain_names
std::vector< std::string > get_gain_names(size_t chan=0)
freesrp_sink_c::get_gain
double get_gain(size_t chan=0)
freesrp_sink_c::set_gain
double set_gain(double gain, const std::string &name, size_t chan=0)
freesrp_sink_c::set_antenna
std::string set_antenna(const std::string &antenna, size_t chan=0)
freesrp_sink_c::get_gain_range
osmosdr::gain_range_t get_gain_range(size_t chan=0)
freesrp_sink_c::set_bb_gain
double set_bb_gain(double gain, size_t chan=0)
freesrp_sink_c::get_antenna
std::string get_antenna(size_t chan=0)
freesrp_sink_c::get_bandwidth
double get_bandwidth(size_t chan=0)
freesrp_sink_c::work
int work(int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)
freesrp_sink_c::start
bool start()
freesrp_sink_c::get_sample_rates
osmosdr::meta_range_t get_sample_rates(void)
Definition freesrp_sink_c.h:80
moodycamel::ReaderWriterQueue
Definition readerwriterqueue.h:42
sink_iface
Definition sink_iface.h:33
freesrp_common.h
make_freesrp_sink_c
freesrp_sink_c_sptr make_freesrp_sink_c(const std::string &args="")
Return a shared_ptr to a new instance of freesrp_sink_c.
ranges.h
readerwriterqueue.h
sink_iface.h
osmosdr::meta_range_t
Definition ranges.h:75