Imported Upstream version 3.2.2
[debian/gnuradio] / gr-usrp / src / usrp_source_c.h
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2004 Free Software Foundation, Inc.
4  * 
5  * This file is part of GNU Radio
6  * 
7  * GNU Radio is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 3, or (at your option)
10  * any later version.
11  * 
12  * GNU Radio is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  * 
17  * You should have received a copy of the GNU General Public License
18  * along with GNU Radio; see the file COPYING.  If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street,
20  * Boston, MA 02110-1301, USA.
21  */
22
23 #ifndef INCLUDED_USRP_SOURCE_C_H
24 #define INCLUDED_USRP_SOURCE_C_H
25
26 #include <usrp_source_base.h>
27 #include <stdexcept>
28
29 class usrp_standard_rx;
30
31
32 class usrp_source_c;
33 typedef boost::shared_ptr<usrp_source_c> usrp_source_c_sptr;
34
35
36 // public shared_ptr constructor
37
38 usrp_source_c_sptr
39 usrp_make_source_c (int which_board=0,
40                      unsigned int decim_rate=16,
41                      int nchan = 1,
42                      int mux = -1,
43                      int mode = 0,
44                      int fusb_block_size = 0,
45                      int fusb_nblocks = 0,
46                      const std::string fpga_filename = "",
47                      const std::string firmware_filename = ""
48                      ) throw (std::runtime_error);
49
50 /*!
51  * \brief Interface to Universal Software Radio Peripheral Rx path
52  * \ingroup usrp
53  * \ingroup source_blk
54  *
55  * output: 1 stream of complex<float>
56  */
57 class usrp_source_c : public usrp_source_base {
58  private:
59   friend usrp_source_c_sptr
60   usrp_make_source_c (int which_board,
61                        unsigned int decim_rate,
62                        int nchan,
63                        int mux,
64                        int mode,
65                        int fusb_block_size,
66                        int fusb_nblocks,
67                        const std::string fpga_filename,
68                        const std::string firmware_filename
69                        ) throw (std::runtime_error);
70
71  protected:
72   usrp_source_c (int which_board,
73                   unsigned int decim_rate,
74                   int nchan,
75                   int mux,
76                   int mode,
77                   int fusb_block_size,
78                   int fusb_nblocks,
79                   const std::string fpga_filename,
80                   const std::string firmware_filename
81                   ) throw (std::runtime_error);
82
83   virtual int ninput_bytes_reqd_for_noutput_items (int noutput_items);
84
85   virtual void copy_from_usrp_buffer (gr_vector_void_star &output_items,
86                                       int output_index,
87                                       int output_items_available,
88                                       int &output_items_produced,
89                                       const void *usrp_buffer,
90                                       int usrp_buffer_length,
91                                       int &bytes_read);
92
93  public:
94   ~usrp_source_c ();
95 };
96
97 #endif /* INCLUDED_USRP_SOURCE_C_H */