git.gag.com Git - debian/gnuradio/blob - gnuradio-core/src/lib/general/gr_ofdm_insert_preamble.h

   1 /* -*- c++ -*- */
   2 /*
   3  * Copyright 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 along
  18  * with this program; if not, write to the Free Software Foundation, Inc.,
  19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  20  */
  21
  22 #ifndef INCLUDED_GR_OFDM_INSERT_PREAMBLE_H
  23 #define INCLUDED_GR_OFDM_INSERT_PREAMBLE_H
  24
  25 #include <gr_block.h>
  26 #include <vector>
  27
  28 class gr_ofdm_insert_preamble;
  29 typedef boost::shared_ptr<gr_ofdm_insert_preamble> gr_ofdm_insert_preamble_sptr;
  30
  31 gr_ofdm_insert_preamble_sptr
  32 gr_make_ofdm_insert_preamble(int fft_length,
  33                              const std::vector<std::vector<gr_complex> > &preamble);
  34
  35 /*!
  36  * \brief insert "pre-modulated" preamble symbols before each payload.
  37  * \ingroup sync_blk
  38  * \ingroup ofdm_blk
  39  *
  40  * <pre>
  41  * input 1: stream of vectors of gr_complex [fft_length]
  42  *          These are the modulated symbols of the payload.
  43  *
  44  * input 2: stream of char.  The LSB indicates whether the corresponding
  45  *          symbol on input 1 is the first symbol of the payload or not.
  46  *          It's a 1 if the corresponding symbol is the first symbol,
  47  *          otherwise 0.
  48  *
  49  * N.B., this implies that there must be at least 1 symbol in the payload.
  50  *
  51  *
  52  * output 1: stream of vectors of gr_complex [fft_length]
  53  *           These include the preamble symbols and the payload symbols.
  54  *
  55  * output 2: stream of char.  The LSB indicates whether the corresponding
  56  *           symbol on input 1 is the first symbol of a packet (i.e., the
  57  *           first symbol of the preamble.)   It's a 1 if the corresponding
  58  *           symbol is the first symbol, otherwise 0.
  59  * </pre>
  60  *
  61  * \param fft_length length of each symbol in samples.
  62  * \param preamble   vector of symbols that represent the pre-modulated preamble.
  63  */
  64
  65 class gr_ofdm_insert_preamble : public gr_block
  66 {
  67   friend gr_ofdm_insert_preamble_sptr
  68   gr_make_ofdm_insert_preamble(int fft_length,
  69                                const std::vector<std::vector<gr_complex> > &preamble);
  70
  71 protected:
  72   gr_ofdm_insert_preamble(int fft_length,
  73                           const std::vector<std::vector<gr_complex> > &preamble);
  74
  75 private:
  76   enum state_t {
  77     ST_IDLE,
  78     ST_PREAMBLE,
  79     ST_FIRST_PAYLOAD,
  80     ST_PAYLOAD
  81   };
  82
  83   int                                           d_fft_length;
  84   const std::vector<std::vector<gr_complex> >   d_preamble;
  85   state_t                                       d_state;
  86   int                                           d_nsymbols_output;
  87   int                                           d_pending_flag;
  88
  89   void enter_idle();
  90   void enter_preamble();
  91   void enter_first_payload();
  92   void enter_payload();
  93
  94
  95 public:
  96   ~gr_ofdm_insert_preamble();
  97
  98   int general_work (int noutput_items,
  99                     gr_vector_int &ninput_items,
 100                     gr_vector_const_void_star &input_items,
 101                     gr_vector_void_star &output_items);
 102 };
 103
 104 #endif /* INCLUDED_GR_OFDM_INSERT_PREAMBLE_H */