codec2_encode_sp.h

Go to the documentation of this file.

/* -*- c++ -*- */
/*
 * Copyright 2005,2013,2014 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.
 */

#ifndef INCLUDED_VOCODER_CODEC2_ENCODE_SP_H
#define INCLUDED_VOCODER_CODEC2_ENCODE_SP_H

#include <gnuradio/vocoder/api.h>
#include <gnuradio/vocoder/codec2.h>
#include <gnuradio/sync_decimator.h>

namespace gr {
  namespace vocoder {

    /*!
     * \brief CODEC2 Vocoder Encoder
     * \ingroup audio_blk
     *
     * Input: Speech (audio) signal as 16-bit shorts, sampling rate 8 kHz.
     *
     * Output: Vector of unpacked bits, forming one Codec2 frame, per 160
     *         input samples (in 2400 and 3200 bps modes) or per 320 input
     *         samples (in 1200, 1300, 1400 and 1600 bps modes).
     *
     */
    class VOCODER_API codec2_encode_sp : virtual public sync_decimator
    {
    public:
      // gr::vocoder::codec2_encode_sp::sptr
      typedef boost::shared_ptr<codec2_encode_sp> sptr;

      /*!
       * \brief Make Codec2 encoder block.
       *
       * \param mode Encoded bit rate/mode
       */
      static sptr make(int mode=codec2::MODE_2400);
    };

  } /* namespace vocoder */
} /* namespace gr */

#endif /* INCLUDED_VOCODER_CODEC2_ENCODE_SP_H */