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

   1 /* -*- c++ -*- */
   2 /*
   3  * Copyright 2008,2010 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 #ifndef INCLUDED_GR_ADDITIVE_SCRAMBLER_BB_H
  23 #define INCLUDED_GR_ADDITIVE_SCRAMBLER_BB_H
  24
  25 #include <gr_sync_block.h>
  26 #include "gri_lfsr.h"
  27
  28 class gr_additive_scrambler_bb;
  29 typedef boost::shared_ptr<gr_additive_scrambler_bb> gr_additive_scrambler_bb_sptr;
  30
  31 gr_additive_scrambler_bb_sptr gr_make_additive_scrambler_bb(int mask, int seed, int len, int count=0);
  32
  33 /*!
  34  * Scramble an input stream using an LFSR.  This block works on the LSB only
  35  * of the input data stream, i.e., on an "unpacked binary" stream, and
  36  * produces the same format on its output.
  37  *
  38  * \param mask     Polynomial mask for LFSR
  39  * \param seed     Initial shift register contents
  40  * \param len      Shift register length
  41  * \param count    Number of bits after which shift register is reset, 0=never
  42  *
  43  * The scrambler works by XORing the incoming bit stream by the output of
  44  * the LFSR.  Optionally, after 'count' bits have been processed, the shift
  45  * register is reset to the seed value.  This allows processing fixed length
  46  * vectors of samples.
  47  *
  48  * \ingroup coding_blk
  49  */
  50
  51 class gr_additive_scrambler_bb : public gr_sync_block
  52 {
  53   friend gr_additive_scrambler_bb_sptr gr_make_additive_scrambler_bb(int mask, int seed, int len, int count);
  54
  55   gri_lfsr d_lfsr;
  56   int      d_count;
  57   int      d_bits;
  58
  59   gr_additive_scrambler_bb(int mask, int seed, int len, int count);
  60
  61 public:
  62   int work(int noutput_items,
  63            gr_vector_const_void_star &input_items,
  64            gr_vector_void_star &output_items);
  65 };
  66
  67 #endif /* INCLUDED_GR_ADDITIVE_SCRAMBLER_BB_H */