GNU Radio's OsmoSDR Package
osmosdr_src_c.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2012 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_OSMOSDR_SRC_C_H
21 #define INCLUDED_OSMOSDR_SRC_C_H
22 
23 #include <gnuradio/sync_block.h>
24 
25 #include <gnuradio/thread/thread.h>
26 #include <boost/thread/mutex.hpp>
27 #include <boost/thread/condition_variable.hpp>
28 
29 #include "source_iface.h"
30 
31 class osmosdr_src_c;
32 typedef struct osmosdr_dev osmosdr_dev_t;
33 
34 /*
35  * We use boost::shared_ptr's instead of raw pointers for all access
36  * to gr::blocks (and many other data structures). The shared_ptr gets
37  * us transparent reference counting, which greatly simplifies storage
38  * management issues. This is especially helpful in our hybrid
39  * C++ / Python system.
40  *
41  * See http://www.boost.org/libs/smart_ptr/smart_ptr.htm
42  *
43  * As a convention, the _sptr suffix indicates a boost::shared_ptr
44  */
45 typedef boost::shared_ptr<osmosdr_src_c> osmosdr_src_c_sptr;
46 
47 /*!
48  * \brief Return a shared_ptr to a new instance of osmosdr_src_c.
49  *
50  * To avoid accidental use of raw pointers, osmosdr_src_c's
51  * constructor is private. osmosdr_make_src_c is the public
52  * interface for creating new instances.
53  */
54 osmosdr_src_c_sptr osmosdr_make_src_c (const std::string & args = "");
55 
56 /*!
57  * \brief Provides a stream of complex samples.
58  * \ingroup block
59  *
60  * \sa sink for a version that subclasses gr::hier_block2.
61  */
63  public gr::sync_block,
64  public source_iface
65 {
66 private:
67  // The friend declaration allows osmosdr_make_src_c to
68  // access the private constructor.
69 
70  friend osmosdr_src_c_sptr osmosdr_make_src_c (const std::string & args);
71 
72  /*!
73  * \brief Provides a stream of complex samples.
74  */
75  osmosdr_src_c (const std::string & args); // private constructor
76 
77  public:
78  ~osmosdr_src_c (); // public destructor
79 
80  int work( int noutput_items,
81  gr_vector_const_void_star &input_items,
82  gr_vector_void_star &output_items );
83 
84  static std::vector< std::string > get_devices();
85 
86  size_t get_num_channels( void );
87 
89  double set_sample_rate( double rate );
90  double get_sample_rate( void );
91 
92  osmosdr::freq_range_t get_freq_range( size_t chan = 0 );
93  double set_center_freq( double freq, size_t chan = 0 );
94  double get_center_freq( size_t chan = 0 );
95  double set_freq_corr( double ppm, size_t chan = 0 );
96  double get_freq_corr( size_t chan = 0 );
97 
98  std::vector<std::string> get_gain_names( size_t chan = 0 );
99  osmosdr::gain_range_t get_gain_range( size_t chan = 0 );
100  osmosdr::gain_range_t get_gain_range( const std::string & name, size_t chan = 0 );
101  bool set_gain_mode( bool automatic, size_t chan = 0 );
102  bool get_gain_mode( size_t chan = 0 );
103  double set_gain( double gain, size_t chan = 0 );
104  double set_gain( double gain, const std::string & name, size_t chan = 0 );
105  double get_gain( size_t chan = 0 );
106  double get_gain( const std::string & name, size_t chan = 0 );
107 
108  double set_if_gain( double gain, size_t chan = 0 );
109 
110  std::vector< std::string > get_antennas( size_t chan = 0 );
111  std::string set_antenna( const std::string & antenna, size_t chan = 0 );
112  std::string get_antenna( size_t chan = 0 );
113 
114 private:
115  static void _osmosdr_callback(unsigned char *buf, uint32_t len, void *ctx);
116  void osmosdr_callback(unsigned char *buf, uint32_t len);
117  static void _osmosdr_wait(osmosdr_src_c *obj);
118  void osmosdr_wait();
119 
120  osmosdr_dev_t *_dev;
121  gr::thread::thread _thread;
122  unsigned short **_buf;
123  unsigned int _buf_num;
124  unsigned int _buf_len;
125  unsigned int _buf_head;
126  unsigned int _buf_used;
127  boost::mutex _buf_mutex;
128  boost::condition_variable _buf_cond;
129  bool _running;
130 
131  unsigned int _buf_offset;
132  int _samp_avail;
133 
134  bool _auto_gain;
135  double _if_gain;
136  unsigned int _skipped;
137 };
138 
139 #endif /* INCLUDED_OSMOSDR_SRC_C_H */
double set_sample_rate(double rate)
double set_gain(double gain, size_t chan=0)
osmosdr_src_c_sptr osmosdr_make_src_c(const std::string &args="")
Return a shared_ptr to a new instance of osmosdr_src_c.
double set_if_gain(double gain, size_t chan=0)
Definition: source_iface.h:31
size_t get_num_channels(void)
double get_center_freq(size_t chan=0)
double get_freq_corr(size_t chan=0)
std::vector< std::string > get_gain_names(size_t chan=0)
double get_gain(size_t chan=0)
osmosdr::freq_range_t get_freq_range(size_t chan=0)
struct osmosdr_dev osmosdr_dev_t
Definition: osmosdr_src_c.h:32
double get_sample_rate(void)
Definition: ranges.h:69
bool get_gain_mode(size_t chan=0)
static std::vector< std::string > get_devices()
bool set_gain_mode(bool automatic, size_t chan=0)
double set_freq_corr(double ppm, size_t chan=0)
int work(int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)
Provides a stream of complex samples.
Definition: osmosdr_src_c.h:62
double set_center_freq(double freq, size_t chan=0)
osmosdr::gain_range_t get_gain_range(size_t chan=0)
std::string get_antenna(size_t chan=0)
osmosdr::meta_range_t get_sample_rates(void)
friend osmosdr_src_c_sptr osmosdr_make_src_c(const std::string &args)
Return a shared_ptr to a new instance of osmosdr_src_c.
std::vector< std::string > get_antennas(size_t chan=0)
std::string set_antenna(const std::string &antenna, size_t chan=0)