Imported Upstream version 3.0
[debian/gnuradio] / gnuradio-core / src / lib / general / gr_unpack_k_bits_bb.h
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2006 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 2, 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_GR_UNPACK_K_BITS_BB_H
24 #define INCLUDED_GR_UNPACK_K_BITS_BB_H
25
26 #include <gr_sync_interpolator.h>
27
28 class gr_unpack_k_bits_bb;
29 typedef boost::shared_ptr<gr_unpack_k_bits_bb> gr_unpack_k_bits_bb_sptr;
30 gr_unpack_k_bits_bb_sptr gr_make_unpack_k_bits_bb (unsigned k);
31
32 class gr_unpack_k_bits_bb;
33
34 /*!
35  * \brief Converts a byte with k relevent bits to k output bytes with 1 bit in the LSB
36  */
37 class gr_unpack_k_bits_bb : public gr_sync_interpolator
38 {
39  private:
40   friend gr_unpack_k_bits_bb_sptr gr_make_unpack_k_bits_bb (unsigned k);
41
42   gr_unpack_k_bits_bb (unsigned k);
43
44   unsigned d_k;    // number of relevent bits to unpack into k output bytes
45   
46  public:
47   ~gr_unpack_k_bits_bb ();
48
49   int work (int noutput_items,
50             gr_vector_const_void_star &input_items,
51             gr_vector_void_star &output_items);
52 };
53
54 #endif