Changeset 3083 for pjproject/trunk/pjmedia/include/pjmedia-codec/speex.h

Timestamp:

Jan 29, 2010 3:51:09 PM (14 years ago)

Author:

nanang

Message:

Ticket #1028:

• Updated codecs docs, more detail info about codec settings.

File:

• pjproject/trunk/pjmedia/include/pjmedia-codec/speex.h (modified) (2 diffs)

pjproject/trunk/pjmedia/include/pjmedia-codec/speex.h

@@ -34 +34 @@
  * @{
  *
- * This section describes functions to register and register speex codec
+ * This section describes functions to initialize and register speex codec
  * factory to the codec manager. After the codec factory has been registered,
  * application can use @ref PJMEDIA_CODEC API to manipulate the codec.
+ *
+ * The Speex codec uses multiple bit rates, and supports ultra-wideband 
+ * (32 kHz sampling rate), wideband (16 kHz sampling rate) and narrowband 
+ * (telephone quality, 8 kHz sampling rate)
  *
  * By default, the speex codec factory registers three Speex codecs:
@@ -42 +46 @@
  * "speex/32000" ultra-wideband codec. This behavior can be changed by
  * specifying #pjmedia_speex_options flags during initialization.
+ *
+ *
+ * \section codec_setting Codec Settings
+ *
+ * \subsection general_setting General Settings
+ *
+ * General codec settings for this codec such as VAD and PLC can be 
+ * manipulated through the <tt>setting</tt> field in #pjmedia_codec_param. 
+ * Please see the documentation of #pjmedia_codec_param for more info.
+ *
+ * \subsection specific_setting Codec Specific Settings
+ *
+ * The following settings are applicable for this codec.
+ *
+ * \subsubsection quality_vs_complexity Quality vs Complexity
+ *
+ * The Speex codec quality versus computational complexity and bandwidth
+ * requirement can be adjusted by modifying the quality and complexity
+ * setting, by calling #pjmedia_codec_speex_set_param(). The RFC 5574
+ * Section 5 shows the relationship between quality setting and the
+ * resulting bitrate.
+ *
+ * The default setting of quality is specified in 
+ * #PJMEDIA_CODEC_SPEEX_DEFAULT_QUALITY. And the default setting of
+ * complexity is specified in #PJMEDIA_CODEC_SPEEX_DEFAULT_COMPLEXITY.
  */