GNU Radio's TEST Package

rfspace_source_c.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2013 Dimitri Stolnikov <horiz0n@gmx.net>
4 *
5 * GNU Radio is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 3, or (at your option)
8 * any later version.
9 *
10 * GNU Radio is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with GNU Radio; see the file COPYING. If not, write to
17 * the Free Software Foundation, Inc., 51 Franklin Street,
18 * Boston, MA 02110-1301, USA.
19 */
20#ifndef INCLUDED_RFSPACE_SOURCE_C_H
21#define INCLUDED_RFSPACE_SOURCE_C_H
22
23#include <gnuradio/thread/thread.h>
24#include <gnuradio/block.h>
25#include <gnuradio/sync_block.h>
26
27#include <boost/circular_buffer.hpp>
28
29#include <mutex>
30#include <condition_variable>
31
32#include "osmosdr/ranges.h"
33#include "source_iface.h"
34 class rfspace_source_c;
35
36#ifndef SOCKET
37#define SOCKET int
38#endif
39
40/*
41 * We use std::shared_ptr's instead of raw pointers for all access
42 * to gr_blocks (and many other data structures). The shared_ptr gets
43 * us transparent reference counting, which greatly simplifies storage
44 * management issues. This is especially helpful in our hybrid
45 * C++ / Python system.
46 *
47 * See http://www.boost.org/libs/smart_ptr/smart_ptr.htm
48 *
49 * As a convention, the _sptr suffix indicates a std::shared_ptr
50 */
51 typedef std::shared_ptr<rfspace_source_c> rfspace_source_c_sptr;
52
53/*!
54 * \brief Return a shared_ptr to a new instance of rfspace_source_c.
55 *
56 * To avoid accidental use of raw pointers, rfspace_source_c's
57 * constructor is private. rfspace_make_source_c is the public
58 * interface for creating new instances.
59 */
60rfspace_source_c_sptr make_rfspace_source_c (const std::string & args = "");
61
62 class rfspace_source_c :
63 public gr::sync_block,
64 public source_iface
65{
66 private:
67 // The friend declaration allows rfspace_make_source_c to
68 // access the private constructor.
69 friend rfspace_source_c_sptr make_rfspace_source_c (const std::string & args);
70
71 rfspace_source_c (const std::string & args); // private constructor
72
73 public:
74 ~rfspace_source_c (); // public destructor
75
76 bool start();
77 bool stop();
78
79 int work(int noutput_items,
80 gr_vector_const_void_star &input_items,
81 gr_vector_void_star &output_items );
82
83 static std::vector< std::string > get_devices( bool fake = false );
84
85 size_t get_num_channels( void );
86
87 osmosdr::meta_range_t get_sample_rates( void );
88 double set_sample_rate( double rate );
89 double get_sample_rate( void );
90
91 osmosdr::freq_range_t get_freq_range( size_t chan = 0 );
92 double set_center_freq( double freq, size_t chan = 0 );
93 double get_center_freq( size_t chan = 0 );
94 double set_freq_corr( double ppm, size_t chan = 0 );
95 double get_freq_corr( size_t chan = 0 );
96
97 std::vector<std::string> get_gain_names( size_t chan = 0 );
98 osmosdr::gain_range_t get_gain_range( size_t chan = 0 );
99 osmosdr::gain_range_t get_gain_range( const std::string & name, size_t chan = 0 );
100 bool set_gain_mode( bool automatic, size_t chan = 0 );
101 bool get_gain_mode( size_t chan = 0 );
102 double set_gain( double gain, size_t chan = 0 );
103 double set_gain( double gain, const std::string & name, size_t chan = 0 );
104 double get_gain( size_t chan = 0 );
105 double get_gain( const std::string & name, size_t chan = 0 );
106
107 std::vector< std::string > get_antennas( size_t chan = 0 );
108 std::string set_antenna( const std::string & antenna, size_t chan = 0 );
109 std::string get_antenna( size_t chan = 0 );
110
111 double set_bandwidth( double bandwidth, size_t chan = 0 );
112 double get_bandwidth( size_t chan = 0 );
113 osmosdr::freq_range_t get_bandwidth_range( size_t chan = 0 );
114
115 private: /* functions */
116 void apply_channel( unsigned char *cmd, size_t chan = 0 );
117
118 bool transaction( const unsigned char *cmd, size_t size );
119
120 bool transaction( const unsigned char *cmd, size_t size,
121 std::vector< unsigned char > &response );
122
123 void usb_read_task();
124 void tcp_keepalive_task();
125
126 private: /* members */
127 enum radio_type
128 {
129 RADIO_UNKNOWN = 0,
130 RFSPACE_SDR_IQ,
131 RFSPACE_SDR_IP,
132 RFSPACE_NETSDR,
133 RFSPACE_CLOUDIQ,
134 RFSPACE_CLOUDSDR
135 };
136
137 radio_type _radio;
138
139 SOCKET _tcp;
140 SOCKET _udp;
141 int _usb;
142 bool _running;
143 bool _keep_running;
144 uint16_t _sequence;
145
146 size_t _nchan;
147 double _sample_rate;
148 double _bandwidth;
149
150 gr::thread::thread _thread;
151 bool _run_usb_read_task;
152 bool _run_tcp_keepalive_task;
153 std::mutex _tcp_lock;
154
155 boost::circular_buffer<gr_complex> *_fifo;
156 std::mutex _fifo_lock;
157 std::condition_variable _samp_avail;
158
159 std::vector< unsigned char > _resp;
160 std::mutex _resp_lock;
161 std::condition_variable _resp_avail;
162};
163
164#endif /* INCLUDED_RFSPACE_SOURCE_C_H */
rfspace_source_c
Definition: rfspace_source_c.h:65
rfspace_source_c::get_num_channels
size_t get_num_channels(void)
rfspace_source_c::stop
bool stop()
rfspace_source_c::set_bandwidth
double set_bandwidth(double bandwidth, size_t chan=0)
rfspace_source_c::start
bool start()
rfspace_source_c::get_antennas
std::vector< std::string > get_antennas(size_t chan=0)
rfspace_source_c::get_devices
static std::vector< std::string > get_devices(bool fake=false)
rfspace_source_c::get_gain_mode
bool get_gain_mode(size_t chan=0)
rfspace_source_c::set_antenna
std::string set_antenna(const std::string &antenna, size_t chan=0)
rfspace_source_c::get_freq_corr
double get_freq_corr(size_t chan=0)
rfspace_source_c::set_center_freq
double set_center_freq(double freq, size_t chan=0)
rfspace_source_c::get_gain_range
osmosdr::gain_range_t get_gain_range(const std::string &name, size_t chan=0)
rfspace_source_c::set_freq_corr
double set_freq_corr(double ppm, size_t chan=0)
rfspace_source_c::get_gain_names
std::vector< std::string > get_gain_names(size_t chan=0)
rfspace_source_c::get_gain
double get_gain(const std::string &name, size_t chan=0)
rfspace_source_c::get_center_freq
double get_center_freq(size_t chan=0)
rfspace_source_c::work
int work(int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)
rfspace_source_c::set_gain_mode
bool set_gain_mode(bool automatic, size_t chan=0)
rfspace_source_c::get_freq_range
osmosdr::freq_range_t get_freq_range(size_t chan=0)
rfspace_source_c::set_gain
double set_gain(double gain, size_t chan=0)
rfspace_source_c::make_rfspace_source_c
friend rfspace_source_c_sptr make_rfspace_source_c(const std::string &args)
Return a shared_ptr to a new instance of rfspace_source_c.
rfspace_source_c::get_antenna
std::string get_antenna(size_t chan=0)
rfspace_source_c::get_gain_range
osmosdr::gain_range_t get_gain_range(size_t chan=0)
rfspace_source_c::get_gain
double get_gain(size_t chan=0)
rfspace_source_c::get_bandwidth
double get_bandwidth(size_t chan=0)
rfspace_source_c::set_sample_rate
double set_sample_rate(double rate)
rfspace_source_c::set_gain
double set_gain(double gain, const std::string &name, size_t chan=0)
rfspace_source_c::get_bandwidth_range
osmosdr::freq_range_t get_bandwidth_range(size_t chan=0)
rfspace_source_c::get_sample_rates
osmosdr::meta_range_t get_sample_rates(void)
rfspace_source_c::~rfspace_source_c
~rfspace_source_c()
rfspace_source_c::get_sample_rate
double get_sample_rate(void)
source_iface
Definition: source_iface.h:33
ranges.h
make_rfspace_source_c
rfspace_source_c_sptr make_rfspace_source_c(const std::string &args="")
Return a shared_ptr to a new instance of rfspace_source_c.
SOCKET
#define SOCKET
Definition: rfspace_source_c.h:37
source_iface.h
osmosdr::meta_range_t
Definition: ranges.h:75