Imported Upstream version 3.0.4
[debian/gnuradio] / gr-usrp / src / usrp1_source_s.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_USRP1_SOURCE_S_H
24 #define INCLUDED_USRP1_SOURCE_S_H
25
26 #include <usrp1_source_base.h>
27 #include <stdexcept>
28
29 class usrp_standard_rx;
30
31
32 class usrp1_source_s;
33 typedef boost::shared_ptr<usrp1_source_s> usrp1_source_s_sptr;
34
35
36 // public shared_ptr constructor
37
38 usrp1_source_s_sptr
39 usrp1_make_source_s (int which_board, 
40                      unsigned int decim_rate,
41                      int nchan,
42                      int mux,
43                      int mode,
44                      int fusb_block_size,
45                      int fusb_nblocks,
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 (Rev 1)
52  *
53  * output: 1 stream of short
54  */
55 class usrp1_source_s : public usrp1_source_base {
56  private:
57   friend usrp1_source_s_sptr
58   usrp1_make_source_s (int which_board, 
59                        unsigned int decim_rate,
60                        int nchan,
61                        int mux,
62                        int mode,
63                        int fusb_block_size,
64                        int fusb_nblocks,
65                        const std::string fpga_filename,
66                        const std::string firmware_filename
67                        ) throw (std::runtime_error);
68
69  protected:
70   usrp1_source_s (int which_board, 
71                   unsigned int decim_rate,
72                   int nchan,
73                   int mux,
74                   int mode,
75                   int fusb_block_size,
76                   int fusb_nblocks,
77                   const std::string fpga_filename,
78                   const std::string firmware_filename
79                   ) throw (std::runtime_error);
80
81   virtual int ninput_bytes_reqd_for_noutput_items (int noutput_items);
82
83   virtual void copy_from_usrp_buffer (gr_vector_void_star &output_items,
84                                       int output_index,
85                                       int output_items_available,
86                                       int &output_items_produced,
87                                       const void *usrp_buffer,
88                                       int usrp_buffer_length,
89                                       int &bytes_read);
90  public:
91   ~usrp1_source_s ();
92 };
93
94 #endif /* INCLUDED_USRP1_SOURCE_S_H */