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

   1 /* -*- c++ -*- */
   2 /*
   3  * Copyright 2004 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_SIMPLE_FRAMER_H
  24 #define INCLUDED_GR_SIMPLE_FRAMER_H
  25
  26 #include <gr_block.h>
  27
  28 class gr_simple_framer;
  29 typedef boost::shared_ptr<gr_simple_framer> gr_simple_framer_sptr;
  30
  31 gr_simple_framer_sptr gr_make_simple_framer (int payload_bytesize);
  32
  33 /*!
  34  * \brief add sync field, seq number and command field to payload
  35  * \ingroup block
  36  */
  37 class gr_simple_framer : public gr_block
  38 {
  39   int   d_seqno;
  40   int   d_payload_bytesize;
  41   int   d_input_block_size;     // bytes
  42   int   d_output_block_size;    // bytes
  43
  44   friend gr_simple_framer_sptr gr_make_simple_framer (int payload_bytesize);
  45   gr_simple_framer (int payload_bytesize);
  46
  47  public:
  48   void forecast (int noutput_items,
  49                  gr_vector_int &ninput_items_required);
  50
  51   int general_work (int noutput_items,
  52                     gr_vector_int &ninput_items,
  53                     gr_vector_const_void_star &input_items,
  54                     gr_vector_void_star &output_items);
  55 };
  56
  57
  58 #endif /* INCLUDED_GR_SIMPLE_FRAMER_H */