hackrf_sink_c.h
Go to the documentation of this file.
/* -*- c++ -*- */
/*
* Copyright 2013 Dimitri Stolnikov <horiz0n@gmx.net>
* Copyright 2020 Clayton Smith <argilo@gmail.com>
*
* gr-osmosdr 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.
*
* gr-osmosdr 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 gr-osmosdr; see the file COPYING. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street,
* Boston, MA 02110-1301, USA.
*/
#ifndef INCLUDED_HACKRF_SINK_C_H
#define INCLUDED_HACKRF_SINK_C_H
#include <gnuradio/sync_block.h>
#include <condition_variable>
#include <mutex>
#include <libhackrf/hackrf.h>
#include "sink_iface.h"
#include "hackrf_common.h"
class hackrf_sink_c;
typedef struct circular_buffer
{
void *buffer; // data buffer
void *buffer_end; // end of data buffer
size_t capacity; // maximum number of items in the buffer
size_t count; // number of items in the buffer
size_t sz; // size of each item in the buffer
void *head; // pointer to head
void *tail; // pointer to tail
} circular_buffer_t;
/*
* We use std::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 std::shared_ptr
*/
typedef std::shared_ptr<hackrf_sink_c> hackrf_sink_c_sptr;
/*!
* \brief Return a shared_ptr to a new instance of hackrf_sink_c.
*
* To avoid accidental use of raw pointers, hackrf_sink_c's
* constructor is private. make_hackrf_sink_c is the public
* interface for creating new instances.
*/
hackrf_sink_c_sptr make_hackrf_sink_c (const std::string & args = "");
class hackrf_sink_c :
public gr::sync_block,
public sink_iface,
protected hackrf_common
{
private:
// The friend declaration allows hackrf_make_sink_c to
// access the private constructor.
friend hackrf_sink_c_sptr make_hackrf_sink_c (const std::string & args);
hackrf_sink_c (const std::string & args); // private constructor
public:
~hackrf_sink_c (); // public destructor
bool start();
bool stop();
int work( int noutput_items,
gr_vector_const_void_star &input_items,
gr_vector_void_star &output_items );
static std::vector< std::string > get_devices();
size_t get_num_channels( void );
osmosdr::meta_range_t get_sample_rates( void );
double set_sample_rate( double rate );
double get_sample_rate( void );
osmosdr::freq_range_t get_freq_range( size_t chan = 0 );
double set_center_freq( double freq, size_t chan = 0 );
double get_center_freq( size_t chan = 0 );
double set_freq_corr( double ppm, size_t chan = 0 );
double get_freq_corr( 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 );
bool set_gain_mode( bool automatic, size_t chan = 0 );
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_if_gain( double gain, 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 );
osmosdr::freq_range_t get_bandwidth_range( size_t chan = 0 );
private:
static int _hackrf_tx_callback(hackrf_transfer* transfer);
int hackrf_tx_callback(unsigned char *buffer, uint32_t length);
circular_buffer_t _cbuf;
int8_t *_buf;
unsigned int _buf_num;
unsigned int _buf_used;
bool _stopping;
std::mutex _buf_mutex;
std::condition_variable _buf_cond;
double _vga_gain;
};
#endif /* INCLUDED_HACKRF_SINK_C_H */
hackrf_common::hackrf_common
hackrf_common(const std::string &args)
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.
osmosdr::freq_range_t
meta_range_t freq_range_t
Definition ranges.h:125
osmosdr::gain_range_t
meta_range_t gain_range_t
Definition ranges.h:124
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