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

   1 /* -*- c++ -*- */
   2 /*
   3  * Copyright 2005,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_CORRELATE_ACCESS_CODE_BB_H
  24 #define INCLUDED_GR_CORRELATE_ACCESS_CODE_BB_H
  25
  26 #include <gr_sync_block.h>
  27 #include <string>
  28
  29 class gr_correlate_access_code_bb;
  30 typedef boost::shared_ptr<gr_correlate_access_code_bb> gr_correlate_access_code_bb_sptr;
  31
  32 /*!
  33  * \param access_code is represented with 1 byte per bit, e.g., "010101010111000100"
  34  * \param threshold maximum number of bits that may be wrong
  35  */
  36 gr_correlate_access_code_bb_sptr
  37 gr_make_correlate_access_code_bb (const std::string &access_code, int threshold);
  38
  39 /*!
  40  * \brief Examine input for specified access code, one bit at a time.
  41  * \ingroup block
  42  *
  43  * input:  stream of bits, 1 bit per input byte (data in LSB)
  44  * output: stream of bits, 2 bits per output byte (data in LSB, flag in next higher bit)
  45  *
  46  * Each output byte contains two valid bits, the data bit, and the
  47  * flag bit.  The LSB (bit 0) is the data bit, and is the original
  48  * input data, delayed 64 bits.  Bit 1 is the
  49  * flag bit and is 1 if the corresponding data bit is the first data
  50  * bit following the access code. Otherwise the flag bit is 0.
  51  */
  52 class gr_correlate_access_code_bb : public gr_sync_block
  53 {
  54   friend gr_correlate_access_code_bb_sptr
  55   gr_make_correlate_access_code_bb (const std::string &access_code, int threshold);
  56  private:
  57   unsigned long long d_access_code;     // access code to locate start of packet
  58                                         //   access code is left justified in the word
  59   unsigned long long d_data_reg;        // used to look for access_code
  60   unsigned long long d_flag_reg;        // keep track of decisions
  61   unsigned long long d_flag_bit;        // mask containing 1 bit which is location of new flag
  62   unsigned long long d_mask;            // masks access_code bits (top N bits are set where
  63                                         //   N is the number of bits in the access code)
  64   unsigned int       d_threshold;       // how many bits may be wrong in sync vector
  65   unsigned int       d_flip;            // flip bits if 180 degress out of sync
  66
  67
  68  protected:
  69   gr_correlate_access_code_bb(const std::string &access_code, int threshold);
  70
  71  public:
  72   ~gr_correlate_access_code_bb();
  73
  74   int work(int noutput_items,
  75            gr_vector_const_void_star &input_items,
  76            gr_vector_void_star &output_items);
  77
  78
  79   /*!
  80    * \param access_code is represented with 1 byte per bit, e.g., "010101010111000100"
  81    */
  82   bool set_access_code (const std::string &access_code);
  83 };
  84
  85 #endif /* INCLUDED_GR_CORRELATE_ACCESS_CODE_BB_H */