diff options
Diffstat (limited to 'gr-vocoder/include/gnuradio/vocoder/codec2_encode_sp.h')
| -rw-r--r-- | gr-vocoder/include/gnuradio/vocoder/codec2_encode_sp.h | 15 |
1 files changed, 13 insertions, 2 deletions
diff --git a/gr-vocoder/include/gnuradio/vocoder/codec2_encode_sp.h b/gr-vocoder/include/gnuradio/vocoder/codec2_encode_sp.h index 9fe1c2dd43..12b91b0428 100644 --- a/gr-vocoder/include/gnuradio/vocoder/codec2_encode_sp.h +++ b/gr-vocoder/include/gnuradio/vocoder/codec2_encode_sp.h @@ -1,6 +1,6 @@ /* -*- c++ -*- */ /* - * Copyright 2005,2013 Free Software Foundation, Inc. + * Copyright 2005,2013,2014 Free Software Foundation, Inc. * * This file is part of GNU Radio * @@ -32,13 +32,24 @@ namespace gr { /*! * \brief CODEC2 Vocoder Encoder * \ingroup audio_blk + * + * Input: Speech (audio) signal as 16-bit shorts, sampling rate 8 kHz. + * + * Output: Vector of 50 unpacked bits, forming one Codec2 frame, per 160 input samples. + * + * Note that the Codec2 library produces 7 bytes with a total of 50 bits + * per frame. The bits are MSB-first on these 7 bytes, so the first item + * of the output vector is the MSB of the first byte of the frame. + * If this block is combined with the gr::vocoder::codec2_decode_ps block, + * this will work out of the box. + * */ 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. */ |