GNU Radio's TEST Package

freesrp_sink_c.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2015 Lukas Lao Beyer
4 * Copyright 2013 Dimitri Stolnikov <horiz0n@gmx.net>
5 *
6 * GNU Radio is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 3, or (at your option)
9 * any later version.
10 *
11 * GNU Radio is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with GNU Radio; see the file COPYING. If not, write to
18 * the Free Software Foundation, Inc., 51 Franklin Street,
19 * Boston, MA 02110-1301, USA.
20 */
21#ifndef INCLUDED_FREESRP_SINK_C_H
22#define INCLUDED_FREESRP_SINK_C_H
23
24#include <gnuradio/thread/thread.h>
25#include <gnuradio/block.h>
26#include <gnuradio/sync_block.h>
27
28#include "osmosdr/ranges.h"
29#include "sink_iface.h"
30
31#include "freesrp_common.h"
32#include "readerwriterqueue/readerwriterqueue.h"
33
34#include <mutex>
35#include <condition_variable>
36
37#include <freesrp.hpp>
38
39 class freesrp_sink_c;
40
41/*
42 * We use std::shared_ptr's instead of raw pointers for all access
43 * to gr_blocks (and many other data structures). The shared_ptr gets
44 * us transparent reference counting, which greatly simplifies storage
45 * management issues. This is especially helpful in our hybrid
46 * C++ / Python system.
47 *
48 * See http://www.boost.org/libs/smart_ptr/smart_ptr.htm
49 *
50 * As a convention, the _sptr suffix indicates a std::shared_ptr
51 */
52 typedef std::shared_ptr<freesrp_sink_c> freesrp_sink_c_sptr;
53
54/*!
55 * \brief Return a shared_ptr to a new instance of freesrp_sink_c.
56 *
57 * To avoid accidental use of raw pointers, freesrp_sink_c's
58 * constructor is private. make_freesrp_sink_c is the public
59 * interface for creating new instances.
60 */
61freesrp_sink_c_sptr make_freesrp_sink_c (const std::string & args = "");
62
63 class freesrp_sink_c :
64 public gr::sync_block,
65 public sink_iface,
66 public freesrp_common
67{
68 private:
69 // The friend declaration allows freesrp_make_sink_c to
70 // access the private constructor.
71 friend freesrp_sink_c_sptr make_freesrp_sink_c (const std::string & args);
72
73 freesrp_sink_c (const std::string & args); // private constructor
74
75 public:
76
77 // From freesrp_common:
78 static std::vector<std::string> get_devices() { return freesrp_common::get_devices(); };
79 size_t get_num_channels( void ) { return freesrp_common::get_num_channels(); }
80 osmosdr::meta_range_t get_sample_rates( void ) { return freesrp_common::get_sample_rates(); }
81 osmosdr::freq_range_t get_freq_range( size_t chan = 0 ) { return freesrp_common::get_freq_range(chan); }
82 osmosdr::freq_range_t get_bandwidth_range( size_t chan = 0 ) { return freesrp_common::get_bandwidth_range(chan); }
83 double set_freq_corr( double ppm, size_t chan = 0 ) { return freesrp_common::set_freq_corr(ppm, chan); }
84 double get_freq_corr( size_t chan = 0 ) { return freesrp_common::get_freq_corr(chan); }
85
86 bool start();
87 bool stop();
88
89 int work( int noutput_items,
90 gr_vector_const_void_star &input_items,
91 gr_vector_void_star &output_items );
92
93 double set_sample_rate( double rate );
94 double get_sample_rate( void );
95
96 double set_center_freq( double freq, size_t chan = 0 );
97 double get_center_freq( size_t chan = 0 );
98
99 std::vector<std::string> get_gain_names( size_t chan = 0 );
100 osmosdr::gain_range_t get_gain_range( size_t chan = 0 );
101 osmosdr::gain_range_t get_gain_range( const std::string & name, size_t chan = 0 );
102 //TODO: implement this: bool set_gain_mode( bool automatic, size_t chan = 0 );
103 //TODO: implement this: bool get_gain_mode( size_t chan = 0 );
104 double set_gain( double gain, size_t chan = 0 );
105 double set_gain( double gain, const std::string & name, size_t chan = 0 );
106 double get_gain( size_t chan = 0 );
107 double get_gain( const std::string & name, size_t chan = 0 );
108
109 double set_bb_gain( double gain, size_t chan = 0 );
110
111 std::vector< std::string > get_antennas( size_t chan = 0 );
112 std::string set_antenna( const std::string & antenna, size_t chan = 0 );
113 std::string get_antenna( size_t chan = 0 );
114
115 double set_bandwidth( double bandwidth, size_t chan = 0 );
116 double get_bandwidth( size_t chan = 0 );
117
118 private:
119
120 void freesrp_tx_callback(std::vector<::FreeSRP::sample> &samples);
121
122 bool _running = false;
123
124 std::mutex _buf_mut{};
125 std::condition_variable _buf_cond{};
126 size_t _buf_available_space = FREESRP_RX_TX_QUEUE_SIZE;
127 moodycamel::ReaderWriterQueue<::FreeSRP::sample> _buf_queue{FREESRP_RX_TX_QUEUE_SIZE};
128};
129
130#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<::FreeSRP::sample >
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