GNU Radio's TEST Package

freesrp_source_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_SOURCE_C_H
22#define INCLUDED_FREESRP_SOURCE_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 "source_iface.h"
30
31#include "freesrp_common.h"
32
33#include "readerwriterqueue/readerwriterqueue.h"
34
35#include <freesrp.hpp>
36
37#include <mutex>
38#include <condition_variable>
39
40 class freesrp_source_c;
41
42/*
43 * We use std::shared_ptr's instead of raw pointers for all access
44 * to gr_blocks (and many other data structures). The shared_ptr gets
45 * us transparent reference counting, which greatly simplifies storage
46 * management issues. This is especially helpful in our hybrid
47 * C++ / Python system.
48 *
49 * See http://www.boost.org/libs/smart_ptr/smart_ptr.htm
50 *
51 * As a convention, the _sptr suffix indicates a std::shared_ptr
52 */
53 typedef std::shared_ptr<freesrp_source_c> freesrp_source_c_sptr;
54
55/*!
56 * \brief Return a shared_ptr to a new instance of freesrp_source_c.
57 *
58 * To avoid accidental use of raw pointers, freesrp_source_c's
59 * constructor is private. freesrp_make_source_c is the public
60 * interface for creating new instances.
61 */
62freesrp_source_c_sptr make_freesrp_source_c (const std::string & args = "");
63
64 class freesrp_source_c :
65 public gr::sync_block,
66 public source_iface,
67 public freesrp_common
68{
69 private:
70 // The friend declaration allows freesrp_make_source_c to
71 // access the private constructor.
72 friend freesrp_source_c_sptr make_freesrp_source_c (const std::string & args);
73
74 freesrp_source_c (const std::string & args); // private constructor
75
76 public:
77
78 // From freesrp_common:
79 static std::vector<std::string> get_devices() { return freesrp_common::get_devices(); };
80 size_t get_num_channels( void ) { return freesrp_common::get_num_channels(); }
81 osmosdr::meta_range_t get_sample_rates( void ) { return freesrp_common::get_sample_rates(); }
82 osmosdr::freq_range_t get_freq_range( size_t chan = 0 ) { return freesrp_common::get_freq_range(chan); }
83 osmosdr::freq_range_t get_bandwidth_range( size_t chan = 0 ) { return freesrp_common::get_bandwidth_range(chan); }
84 double set_freq_corr( double ppm, size_t chan = 0 ) { return freesrp_common::set_freq_corr(ppm, chan); }
85 double get_freq_corr( size_t chan = 0 ) { return freesrp_common::get_freq_corr(chan); }
86
87 bool start();
88 bool stop();
89
90 int work( int noutput_items,
91 gr_vector_const_void_star &input_items,
92 gr_vector_void_star &output_items );
93
94 double set_sample_rate( double rate );
95 double get_sample_rate( void );
96
97 double set_center_freq( double freq, size_t chan = 0 );
98 double get_center_freq( size_t chan = 0 );
99
100 std::vector<std::string> get_gain_names( size_t chan = 0 );
101 osmosdr::gain_range_t get_gain_range( size_t chan = 0 );
102 osmosdr::gain_range_t get_gain_range( const std::string & name, size_t chan = 0 );
103 bool set_gain_mode( bool automatic, size_t chan = 0 );
104 bool get_gain_mode( size_t chan = 0 );
105 double set_gain( double gain, size_t chan = 0 );
106 double set_gain( double gain, const std::string & name, size_t chan = 0 );
107 double get_gain( size_t chan = 0 );
108 double get_gain( const std::string & name, size_t chan = 0 );
109
110 double set_bb_gain( double gain, size_t chan = 0 );
111
112 std::vector< std::string > get_antennas( size_t chan = 0 );
113 std::string set_antenna( const std::string & antenna, size_t chan = 0 );
114 std::string get_antenna( size_t chan = 0 );
115
116 double set_bandwidth( double bandwidth, size_t chan = 0 );
117 double get_bandwidth( size_t chan = 0 );
118
119 private:
120
121 void freesrp_rx_callback(const std::vector<FreeSRP::sample> &samples);
122
123 bool _running = false;
124
125 std::mutex _buf_mut{};
126 std::condition_variable _buf_cond{};
127 size_t _buf_num_samples = 0;
128 moodycamel::ReaderWriterQueue<FreeSRP::sample> _buf_queue{FREESRP_RX_TX_QUEUE_SIZE};
129};
130
131#endif /* INCLUDED_FREESRP_SOURCE_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_source_c
Definition: freesrp_source_c.h:68
freesrp_source_c::stop
bool stop()
freesrp_source_c::get_devices
static std::vector< std::string > get_devices()
Definition: freesrp_source_c.h:79
freesrp_source_c::get_antennas
std::vector< std::string > get_antennas(size_t chan=0)
freesrp_source_c::get_gain_mode
bool get_gain_mode(size_t chan=0)
freesrp_source_c::get_freq_corr
double get_freq_corr(size_t chan=0)
Definition: freesrp_source_c.h:85
freesrp_source_c::get_center_freq
double get_center_freq(size_t chan=0)
freesrp_source_c::set_bb_gain
double set_bb_gain(double gain, size_t chan=0)
freesrp_source_c::get_gain_range
osmosdr::gain_range_t get_gain_range(size_t chan=0)
freesrp_source_c::get_sample_rate
double get_sample_rate(void)
freesrp_source_c::set_gain
double set_gain(double gain, const std::string &name, size_t chan=0)
freesrp_source_c::get_bandwidth_range
osmosdr::freq_range_t get_bandwidth_range(size_t chan=0)
Definition: freesrp_source_c.h:83
freesrp_source_c::work
int work(int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)
freesrp_source_c::start
bool start()
freesrp_source_c::get_bandwidth
double get_bandwidth(size_t chan=0)
freesrp_source_c::get_gain
double get_gain(size_t chan=0)
freesrp_source_c::set_bandwidth
double set_bandwidth(double bandwidth, size_t chan=0)
freesrp_source_c::set_gain_mode
bool set_gain_mode(bool automatic, size_t chan=0)
freesrp_source_c::get_freq_range
osmosdr::freq_range_t get_freq_range(size_t chan=0)
Definition: freesrp_source_c.h:82
freesrp_source_c::get_gain_range
osmosdr::gain_range_t get_gain_range(const std::string &name, size_t chan=0)
freesrp_source_c::get_antenna
std::string get_antenna(size_t chan=0)
freesrp_source_c::set_freq_corr
double set_freq_corr(double ppm, size_t chan=0)
Definition: freesrp_source_c.h:84
freesrp_source_c::get_gain_names
std::vector< std::string > get_gain_names(size_t chan=0)
freesrp_source_c::get_sample_rates
osmosdr::meta_range_t get_sample_rates(void)
Definition: freesrp_source_c.h:81
freesrp_source_c::set_sample_rate
double set_sample_rate(double rate)
freesrp_source_c::make_freesrp_source_c
friend freesrp_source_c_sptr make_freesrp_source_c(const std::string &args)
Return a shared_ptr to a new instance of freesrp_source_c.
freesrp_source_c::set_center_freq
double set_center_freq(double freq, size_t chan=0)
freesrp_source_c::get_num_channels
size_t get_num_channels(void)
Definition: freesrp_source_c.h:80
freesrp_source_c::set_antenna
std::string set_antenna(const std::string &antenna, size_t chan=0)
freesrp_source_c::set_gain
double set_gain(double gain, size_t chan=0)
freesrp_source_c::get_gain
double get_gain(const std::string &name, size_t chan=0)
moodycamel::ReaderWriterQueue< FreeSRP::sample >
source_iface
Definition: source_iface.h:33
freesrp_common.h
make_freesrp_source_c
freesrp_source_c_sptr make_freesrp_source_c(const std::string &args="")
Return a shared_ptr to a new instance of freesrp_source_c.
ranges.h
readerwriterqueue.h
source_iface.h
osmosdr::meta_range_t
Definition: ranges.h:75