GNU Radio's TEST Package

hackrf_sink_c.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2013 Dimitri Stolnikov <horiz0n@gmx.net>
4 * Copyright 2020 Clayton Smith <argilo@gmail.com>
5 *
6 * gr-osmosdr 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 * gr-osmosdr 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 gr-osmosdr; 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_HACKRF_SINK_C_H
22#define INCLUDED_HACKRF_SINK_C_H
23
24#include <gnuradio/sync_block.h>
25
26#include <condition_variable>
27#include <mutex>
28
29#include <libhackrf/hackrf.h>
30
31#include "sink_iface.h"
32#include "hackrf_common.h"
33
34 class hackrf_sink_c;
35
36 typedef struct circular_buffer
37{
38 void *buffer; // data buffer
39 void *buffer_end; // end of data buffer
40 size_t capacity; // maximum number of items in the buffer
41 size_t count; // number of items in the buffer
42 size_t sz; // size of each item in the buffer
43 void *head; // pointer to head
44 void *tail; // pointer to tail
45} circular_buffer_t;
46
47/*
48 * We use std::shared_ptr's instead of raw pointers for all access
49 * to gr::blocks (and many other data structures). The shared_ptr gets
50 * us transparent reference counting, which greatly simplifies storage
51 * management issues. This is especially helpful in our hybrid
52 * C++ / Python system.
53 *
54 * See http://www.boost.org/libs/smart_ptr/smart_ptr.htm
55 *
56 * As a convention, the _sptr suffix indicates a std::shared_ptr
57 */
58 typedef std::shared_ptr<hackrf_sink_c> hackrf_sink_c_sptr;
59
60/*!
61 * \brief Return a shared_ptr to a new instance of hackrf_sink_c.
62 *
63 * To avoid accidental use of raw pointers, hackrf_sink_c's
64 * constructor is private. make_hackrf_sink_c is the public
65 * interface for creating new instances.
66 */
67hackrf_sink_c_sptr make_hackrf_sink_c (const std::string & args = "");
68
69 class hackrf_sink_c :
70 public gr::sync_block,
71 public sink_iface,
72 protected hackrf_common
73{
74 private:
75 // The friend declaration allows hackrf_make_sink_c to
76 // access the private constructor.
77 friend hackrf_sink_c_sptr make_hackrf_sink_c (const std::string & args);
78
79 hackrf_sink_c (const std::string & args); // private constructor
80
81 public:
82 ~hackrf_sink_c (); // public destructor
83
84 bool start();
85 bool stop();
86
87 int work( int noutput_items,
88 gr_vector_const_void_star &input_items,
89 gr_vector_void_star &output_items );
90
91 static std::vector< std::string > get_devices();
92
93 size_t get_num_channels( void );
94
95 osmosdr::meta_range_t get_sample_rates( void );
96 double set_sample_rate( double rate );
97 double get_sample_rate( void );
98
99 osmosdr::freq_range_t get_freq_range( size_t chan = 0 );
100 double set_center_freq( double freq, size_t chan = 0 );
101 double get_center_freq( size_t chan = 0 );
102 double set_freq_corr( double ppm, size_t chan = 0 );
103 double get_freq_corr( size_t chan = 0 );
104
105 std::vector<std::string> get_gain_names( size_t chan = 0 );
106 osmosdr::gain_range_t get_gain_range( size_t chan = 0 );
107 osmosdr::gain_range_t get_gain_range( const std::string & name, size_t chan = 0 );
108 bool set_gain_mode( bool automatic, size_t chan = 0 );
109 bool get_gain_mode( size_t chan = 0 );
110 double set_gain( double gain, size_t chan = 0 );
111 double set_gain( double gain, const std::string & name, size_t chan = 0 );
112 double get_gain( size_t chan = 0 );
113 double get_gain( const std::string & name, size_t chan = 0 );
114
115 double set_if_gain( double gain, size_t chan = 0 );
116 double set_bb_gain( double gain, size_t chan = 0 );
117
118 std::vector< std::string > get_antennas( size_t chan = 0 );
119 std::string set_antenna( const std::string & antenna, size_t chan = 0 );
120 std::string get_antenna( size_t chan = 0 );
121
122 double set_bandwidth( double bandwidth, size_t chan = 0 );
123 double get_bandwidth( size_t chan = 0 );
124 osmosdr::freq_range_t get_bandwidth_range( size_t chan = 0 );
125
126 private:
127 static int _hackrf_tx_callback(hackrf_transfer* transfer);
128 int hackrf_tx_callback(unsigned char *buffer, uint32_t length);
129
130 circular_buffer_t _cbuf;
131 int8_t *_buf;
132 unsigned int _buf_num;
133 unsigned int _buf_used;
134 bool _stopping;
135 std::mutex _buf_mutex;
136 std::condition_variable _buf_cond;
137
138 double _vga_gain;
139};
140
141#endif /* INCLUDED_HACKRF_SINK_C_H */
hackrf_common
Definition: hackrf_common.h:55
hackrf_sink_c
Definition: hackrf_sink_c.h:73
hackrf_sink_c::get_gain_range
osmosdr::gain_range_t get_gain_range(size_t chan=0)
hackrf_sink_c::get_gain
double get_gain(const std::string &name, size_t chan=0)
hackrf_sink_c::get_freq_range
osmosdr::freq_range_t get_freq_range(size_t chan=0)
hackrf_sink_c::~hackrf_sink_c
~hackrf_sink_c()
hackrf_sink_c::get_devices
static std::vector< std::string > get_devices()
hackrf_sink_c::get_antennas
std::vector< std::string > get_antennas(size_t chan=0)
hackrf_sink_c::make_hackrf_sink_c
friend hackrf_sink_c_sptr make_hackrf_sink_c(const std::string &args)
Return a shared_ptr to a new instance of hackrf_sink_c.
hackrf_sink_c::set_bandwidth
double set_bandwidth(double bandwidth, size_t chan=0)
hackrf_sink_c::get_gain_names
std::vector< std::string > get_gain_names(size_t chan=0)
hackrf_sink_c::set_freq_corr
double set_freq_corr(double ppm, size_t chan=0)
hackrf_sink_c::stop
bool stop()
hackrf_sink_c::set_center_freq
double set_center_freq(double freq, size_t chan=0)
hackrf_sink_c::get_sample_rates
osmosdr::meta_range_t get_sample_rates(void)
hackrf_sink_c::set_gain
double set_gain(double gain, size_t chan=0)
hackrf_sink_c::work
int work(int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)
hackrf_sink_c::get_bandwidth_range
osmosdr::freq_range_t get_bandwidth_range(size_t chan=0)
hackrf_sink_c::set_bb_gain
double set_bb_gain(double gain, size_t chan=0)
hackrf_sink_c::set_gain_mode
bool set_gain_mode(bool automatic, size_t chan=0)
hackrf_sink_c::get_center_freq
double get_center_freq(size_t chan=0)
hackrf_sink_c::set_sample_rate
double set_sample_rate(double rate)
hackrf_sink_c::set_gain
double set_gain(double gain, const std::string &name, size_t chan=0)
hackrf_sink_c::get_gain
double get_gain(size_t chan=0)
hackrf_sink_c::start
bool start()
hackrf_sink_c::get_freq_corr
double get_freq_corr(size_t chan=0)
hackrf_sink_c::get_sample_rate
double get_sample_rate(void)
hackrf_sink_c::get_antenna
std::string get_antenna(size_t chan=0)
hackrf_sink_c::set_antenna
std::string set_antenna(const std::string &antenna, size_t chan=0)
hackrf_sink_c::set_if_gain
double set_if_gain(double gain, size_t chan=0)
hackrf_sink_c::get_bandwidth
double get_bandwidth(size_t chan=0)
hackrf_sink_c::get_num_channels
size_t get_num_channels(void)
hackrf_sink_c::get_gain_range
osmosdr::gain_range_t get_gain_range(const std::string &name, size_t chan=0)
hackrf_sink_c::get_gain_mode
bool get_gain_mode(size_t chan=0)
sink_iface
Definition: sink_iface.h:33
hackrf_common.h
circular_buffer_t
struct circular_buffer circular_buffer_t
make_hackrf_sink_c
hackrf_sink_c_sptr make_hackrf_sink_c(const std::string &args="")
Return a shared_ptr to a new instance of hackrf_sink_c.
sink_iface.h
circular_buffer
Definition: hackrf_sink_c.h:37
circular_buffer::sz
size_t sz
Definition: hackrf_sink_c.h:42
circular_buffer::buffer
void * buffer
Definition: hackrf_sink_c.h:38
circular_buffer::tail
void * tail
Definition: hackrf_sink_c.h:44
circular_buffer::count
size_t count
Definition: hackrf_sink_c.h:41
circular_buffer::buffer_end
void * buffer_end
Definition: hackrf_sink_c.h:39
circular_buffer::capacity
size_t capacity
Definition: hackrf_sink_c.h:40
circular_buffer::head
void * head
Definition: hackrf_sink_c.h:43
osmosdr::meta_range_t
Definition: ranges.h:75