diff options
Diffstat (limited to 'gr-vocoder')
-rw-r--r-- | gr-vocoder/doc/Makefile.am | 3 | ||||
-rw-r--r-- | gr-vocoder/doc/README.vocoder | 12 | ||||
-rw-r--r-- | gr-vocoder/doc/vocoder.dox | 24 | ||||
-rw-r--r-- | gr-vocoder/include/vocoder_cvsd_decode_bs.h | 2 | ||||
-rw-r--r-- | gr-vocoder/include/vocoder_cvsd_encode_sb.h | 8 | ||||
-rw-r--r-- | gr-vocoder/python/__init__.py | 5 |
6 files changed, 51 insertions, 3 deletions
diff --git a/gr-vocoder/doc/Makefile.am b/gr-vocoder/doc/Makefile.am index b1c7b44d5..a277264fe 100644 --- a/gr-vocoder/doc/Makefile.am +++ b/gr-vocoder/doc/Makefile.am @@ -22,3 +22,6 @@ include $(top_srcdir)/Makefile.common SUBDIRS = + +dist_gr_doc_DATA = \ + README.vocoder diff --git a/gr-vocoder/doc/README.vocoder b/gr-vocoder/doc/README.vocoder new file mode 100644 index 000000000..912d664ad --- /dev/null +++ b/gr-vocoder/doc/README.vocoder @@ -0,0 +1,12 @@ +This is the gr-vocoder package. This package includes the various +vocoder blocks in GNU Radio. To use the vocoder blocks, the Python +namespaces is in gnuradio.vocoder, which would be normally imported +as: + + from gnuradio import vocoder + +See the Doxygen documentation for details about the blocks available +in this package. A quick listing of the details can be found in Python +after importing by using: + + help(vocoder) diff --git a/gr-vocoder/doc/vocoder.dox b/gr-vocoder/doc/vocoder.dox new file mode 100644 index 000000000..d98532ffb --- /dev/null +++ b/gr-vocoder/doc/vocoder.dox @@ -0,0 +1,24 @@ +/*! \page page_vocoder Voice Coders and Decoders (Vocoders) + +\section Introduction + +This is the gr-vocoder package. It contains all available vocoders in +GNU Radio. The Python namespaces is in gnuradio.vocoder, which would be +normally imported as: + +\code + from gnuradio import vocoder +\endcode + +See the Doxygen documentation for details about the blocks available +in this package. The relavent blocks are listed in the \ref +vocoder_blk group. + +A quick listing of the details can be found in Python after importing +by using: + +\code + help(vocoder) +\endcode + +*/ diff --git a/gr-vocoder/include/vocoder_cvsd_decode_bs.h b/gr-vocoder/include/vocoder_cvsd_decode_bs.h index dd588c661..104ec2400 100644 --- a/gr-vocoder/include/vocoder_cvsd_decode_bs.h +++ b/gr-vocoder/include/vocoder_cvsd_decode_bs.h @@ -34,6 +34,8 @@ typedef boost::shared_ptr<vocoder_cvsd_decode_bs> vocoder_cvsd_decode_bs_sptr; * values are modeled after the Bluetooth standard and should not be changed, * except by an advanced user * + * \ingroup vocoder_blk + * * \param min_step Minimum step size used to update the internal reference. Default: "10" * \param max_step Maximum step size used to update the internal reference. Default: "1280" * \param step_decay Decay factor applied to step size when there is not a run of J output 1s or 0s. Default: "0.9990234375" (i.e. 1-1/1024) diff --git a/gr-vocoder/include/vocoder_cvsd_encode_sb.h b/gr-vocoder/include/vocoder_cvsd_encode_sb.h index da09b3927..422a2f521 100644 --- a/gr-vocoder/include/vocoder_cvsd_encode_sb.h +++ b/gr-vocoder/include/vocoder_cvsd_encode_sb.h @@ -29,9 +29,11 @@ class vocoder_cvsd_encode_sb; typedef boost::shared_ptr<vocoder_cvsd_encode_sb> vocoder_cvsd_encode_sb_sptr; /*! - * \brief Constructor parameters to initialize the CVSD encoder. The default - * values are modeled after the Bluetooth standard and should not be changed - * except by an advanced user + * \brief Constructor parameters to initialize the CVSD encoder. The + * default values are modeled after the Bluetooth standard and should + * not be changed except by an advanced user + * + * \ingroup vocoder_blk * * \param min_step Minimum step size used to update the internal reference. Default: "10" * \param max_step Maximum step size used to update the internal reference. Default: "1280" diff --git a/gr-vocoder/python/__init__.py b/gr-vocoder/python/__init__.py index eb5fa6fc1..c5477b2be 100644 --- a/gr-vocoder/python/__init__.py +++ b/gr-vocoder/python/__init__.py @@ -19,5 +19,10 @@ # Boston, MA 02110-1301, USA. # +''' +This is the gr-vocoder package. This package includes the various +vocoder blocks in GNU Radio. +''' + from vocoder_swig import * from cvsd import * |