Imported Upstream version 3.2.2
[debian/gnuradio] / gnuradio-core / src / lib / general / gr_ofdm_mapper_bcv.h
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2006,2007 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_GR_OFDM_MAPPER_BCV_H
24 #define INCLUDED_GR_OFDM_MAPPER_BCV_H
25
26 #include <gr_sync_block.h>
27 #include <gr_message.h>
28 #include <gr_msg_queue.h>
29
30 class gr_ofdm_mapper_bcv;
31 typedef boost::shared_ptr<gr_ofdm_mapper_bcv> gr_ofdm_mapper_bcv_sptr;
32
33 gr_ofdm_mapper_bcv_sptr 
34 gr_make_ofdm_mapper_bcv (const std::vector<gr_complex> &constellation, unsigned msgq_limit, 
35                          unsigned occupied_carriers, unsigned int fft_length);
36
37 /*!
38  * \brief take a stream of bytes in and map to a vector of complex
39  * constellation points suitable for IFFT input to be used in an ofdm
40  * modulator.  Abstract class must be subclassed with specific mapping.
41  * \ingroup modulation_blk
42  * \ingroup ofdm_blk
43  */
44
45 class gr_ofdm_mapper_bcv : public gr_sync_block
46 {
47   friend gr_ofdm_mapper_bcv_sptr
48   gr_make_ofdm_mapper_bcv (const std::vector<gr_complex> &constellation, unsigned msgq_limit, 
49                            unsigned occupied_carriers, unsigned int fft_length);
50  protected:
51   gr_ofdm_mapper_bcv (const std::vector<gr_complex> &constellation, unsigned msgq_limit, 
52                       unsigned occupied_carriers, unsigned int fft_length);
53
54  private:
55   std::vector<gr_complex> d_constellation;
56   gr_msg_queue_sptr     d_msgq;
57   gr_message_sptr       d_msg;
58   unsigned              d_msg_offset;
59   bool                  d_eof;
60   
61   unsigned int          d_occupied_carriers;
62   unsigned int          d_fft_length;
63   unsigned int          d_bit_offset;
64   int                   d_pending_flag;
65
66   unsigned long  d_nbits;
67   unsigned char  d_msgbytes;
68   
69   unsigned char d_resid;
70   unsigned int d_nresid;
71
72   std::vector<int> d_subcarrier_map;
73
74   int randsym();
75
76  public:
77   ~gr_ofdm_mapper_bcv(void);
78
79   gr_msg_queue_sptr     msgq() const { return d_msgq; }
80
81   int work(int noutput_items,
82            gr_vector_const_void_star &input_items,
83            gr_vector_void_star &output_items);
84
85 };
86
87 #endif