Imported Upstream version 3.2.2
[debian/gnuradio] / gr-usrp / src / usrp_sink_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_USRP_SINK_S_H
24 #define INCLUDED_USRP_SINK_S_H
25
26 #include <usrp_sink_base.h>
27
28 class usrp_sink_s;
29 typedef boost::shared_ptr<usrp_sink_s> usrp_sink_s_sptr;
30
31
32 // public shared_ptr constructor
33
34 usrp_sink_s_sptr
35 usrp_make_sink_s (int which_board=0,
36                   unsigned int interp_rate=32,
37                   int nchan=1,
38                   int mux=-1,
39                   int fusb_block_size=0,
40                   int fusb_nblocks=0,
41                   const std::string fpga_filename="",
42                   const std::string firmware_filename=""
43                   ) throw (std::runtime_error);
44
45 /*!
46  * \brief Interface to Universal Software Radio Peripheral Tx path
47  * \ingroup usrp
48  * \ingroup sink_blk
49  *
50  * input: short
51  */
52 class usrp_sink_s : public usrp_sink_base {
53  private:
54
55   friend usrp_sink_s_sptr
56   usrp_make_sink_s (int which_board,
57                      unsigned int interp_rate,
58                      int nchan,
59                      int mux,
60                      int fusb_block_size,
61                      int fusb_nblocks,
62                      const std::string fpga_filename,
63                      const std::string firmware_filename
64                      ) throw (std::runtime_error);
65
66  protected:
67   usrp_sink_s (int which_board,
68                 unsigned int interp_rate,
69                 int nchan,
70                 int mux,
71                 int fusb_block_size,
72                 int fusb_nblocks,
73                 const std::string fpga_filename,
74                 const std::string firmware_filename
75                 ) throw (std::runtime_error);
76
77   virtual void copy_to_usrp_buffer (gr_vector_const_void_star &input_items,
78                                     int  input_index,
79                                     int  input_items_available,
80                                     int  &input_items_consumed,
81                                     void *usrp_buffer,
82                                     int  usrp_buffer_length,
83                                     int  &bytes_written);
84  public:
85   ~usrp_sink_s ();
86 };
87
88 #endif /* INCLUDED_USRP_SINK_S_H */