/* -*- c++ -*- */
/*
 * Copyright 2006,2013 Free Software Foundation, Inc.
 *
 * This file is part of GNU Radio
 *
 * GNU Radio is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3, or (at your option)
 * any later version.
 *
 * GNU Radio is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with GNU Radio; see the file COPYING.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street,
 * Boston, MA 02110-1301, USA.
 */

// @WARNING@

#ifndef @GUARD_NAME@
#define @GUARD_NAME@

#include <blocks/api.h>
#include <gr_block.h>
#include <gr_endianness.h>

namespace gr {
  namespace blocks {

    /*!
     * \brief Convert a stream of unpacked bytes or shorts into a stream of packed bytes or shorts.
     * \ingroup converter_blk
     *
     * input: stream of @I_TYPE@; output: stream of @O_TYPE@
     *
     * This is the inverse of gr::blocks::packed_to_unpacked_XX.
     *
     * The low \p bits_per_chunk bits are extracted from each input
     * byte or short.  These bits are then packed densely into the
     * output bytes or shorts, such that all 8 or 16 bits of the
     * output bytes or shorts are filled with valid input bits.  The
     * right thing is done if bits_per_chunk is not a power of two.
     *
     * The combination of gr_packed_to_unpacked_XX followed by
     * gr_chunks_to_symbols_Xf or gr_chunks_to_symbols_Xc handles the
     * general case of mapping from a stream of bytes or shorts into
     * arbitrary float or complex symbols.
     *
     * \sa gr::blocks::packed_to_unpacked_bb, gr::blocks::unpacked_to_packed_bb,
     * \sa gr::blocks::packed_to_unpacked_ss, gr::blocks::unpacked_to_packed_ss,
     * \sa gr::blocks::chunks_to_symbols_bf, gr::blocks::chunks_to_symbols_bc.
     * \sa gr::blocks::chunks_to_symbols_sf, gr::blocks::chunks_to_symbols_sc.
     */
    class BLOCKS_API @NAME@ : virtual public gr_block
    {
    public:
      // gr::blocks::@NAME@::sptr
      typedef boost::shared_ptr<@NAME@> sptr;

      static sptr make(unsigned int bits_per_chunk,
                       gr_endianness_t endianness);
    };

  } /* namespace blocks */
} /* namespace gr */

#endif /* @GUARD_NAME@ */