diff options
-rw-r--r-- | pjmedia/include/pjmedia-codec/amr_helper.h | 2 | ||||
-rw-r--r-- | pjmedia/include/pjmedia-codec/config.h | 42 | ||||
-rw-r--r-- | pjmedia/include/pjmedia-codec/g722.h | 2 | ||||
-rw-r--r-- | pjmedia/include/pjmedia-codec/g7221.h | 2 | ||||
-rw-r--r-- | pjmedia/include/pjmedia-codec/gsm.h | 2 | ||||
-rw-r--r-- | pjmedia/include/pjmedia-codec/ilbc.h | 2 | ||||
-rw-r--r-- | pjmedia/include/pjmedia-codec/ipp_codecs.h | 2 | ||||
-rw-r--r-- | pjmedia/include/pjmedia-codec/l16.h | 2 | ||||
-rw-r--r-- | pjmedia/include/pjmedia-codec/passthrough.h | 2 | ||||
-rw-r--r-- | pjmedia/include/pjmedia-codec/speex.h | 2 | ||||
-rw-r--r-- | pjmedia/include/pjmedia-codec/types.h | 17 | ||||
-rw-r--r-- | pjmedia/include/pjmedia/codec.h | 14 | ||||
-rw-r--r-- | pjmedia/include/pjmedia/g711.h | 4 |
13 files changed, 84 insertions, 11 deletions
diff --git a/pjmedia/include/pjmedia-codec/amr_helper.h b/pjmedia/include/pjmedia-codec/amr_helper.h index 79d324af..8cc232eb 100644 --- a/pjmedia/include/pjmedia-codec/amr_helper.h +++ b/pjmedia/include/pjmedia-codec/amr_helper.h @@ -33,7 +33,7 @@ /** * @defgroup PJMED_AMR_CODEC_HELPER AMR Codec Helper - * @ingroup PJMEDIA_CODEC + * @ingroup PJMEDIA_CODEC_CODECS * @brief AMR common tables and helper functions. * @{ * diff --git a/pjmedia/include/pjmedia-codec/config.h b/pjmedia/include/pjmedia-codec/config.h index 7571db44..79322bb2 100644 --- a/pjmedia/include/pjmedia-codec/config.h +++ b/pjmedia/include/pjmedia-codec/config.h @@ -20,8 +20,21 @@ #ifndef __PJMEDIA_CODEC_CONFIG_H__ #define __PJMEDIA_CODEC_CONFIG_H__ +/** + * @file config.h + * @brief PJMEDIA-CODEC compile time settings + */ + +/** + * @defgroup pjmedia_codec_config PJMEDIA-CODEC Compile Time Settings + * @ingroup PJMEDIA_CODEC + * @brief Various compile time settings such as to enable/disable codecs + * @{ + */ + #include <pjmedia/types.h> + /* * Include config_auto.h if autoconf is used (PJ_AUTOCONF is set) */ @@ -203,22 +216,47 @@ # define PJMEDIA_HAS_PASSTHROUGH_CODECS 0 #endif +/** + * Enable AMR passthrough codec. + * + * Default: 1 + */ #ifndef PJMEDIA_HAS_PASSTHROUGH_CODEC_AMR # define PJMEDIA_HAS_PASSTHROUGH_CODEC_AMR 1 #endif +/** + * Enable G.729 passthrough codec. + * + * Default: 1 + */ #ifndef PJMEDIA_HAS_PASSTHROUGH_CODEC_G729 # define PJMEDIA_HAS_PASSTHROUGH_CODEC_G729 1 #endif +/** + * Enable iLBC passthrough codec. + * + * Default: 1 + */ #ifndef PJMEDIA_HAS_PASSTHROUGH_CODEC_ILBC # define PJMEDIA_HAS_PASSTHROUGH_CODEC_ILBC 1 #endif +/** + * Enable PCMU passthrough codec. + * + * Default: 1 + */ #ifndef PJMEDIA_HAS_PASSTHROUGH_CODEC_PCMU # define PJMEDIA_HAS_PASSTHROUGH_CODEC_PCMU 1 #endif +/** + * Enable PCMA passthrough codec. + * + * Default: 1 + */ #ifndef PJMEDIA_HAS_PASSTHROUGH_CODEC_PCMA # define PJMEDIA_HAS_PASSTHROUGH_CODEC_PCMA 1 #endif @@ -271,4 +309,8 @@ to control which implementation to be used. #endif +/** + * @} + */ + #endif /* __PJMEDIA_CODEC_CONFIG_H__ */ diff --git a/pjmedia/include/pjmedia-codec/g722.h b/pjmedia/include/pjmedia-codec/g722.h index 1726d42f..328356e0 100644 --- a/pjmedia/include/pjmedia-codec/g722.h +++ b/pjmedia/include/pjmedia-codec/g722.h @@ -29,7 +29,7 @@ /** * @defgroup PJMED_G722 G.722 Codec - * @ingroup PJMEDIA_CODEC + * @ingroup PJMEDIA_CODEC_CODECS * @brief Implementation of G.722 Codec * @{ * diff --git a/pjmedia/include/pjmedia-codec/g7221.h b/pjmedia/include/pjmedia-codec/g7221.h index 8c7cbd20..ba66c229 100644 --- a/pjmedia/include/pjmedia-codec/g7221.h +++ b/pjmedia/include/pjmedia-codec/g7221.h @@ -29,7 +29,7 @@ /** * @defgroup PJMED_G7221_CODEC G722.1 Codec - * @ingroup PJMEDIA_CODEC + * @ingroup PJMEDIA_CODEC_CODECS * @brief Implementation of G722.1 codec * @{ * diff --git a/pjmedia/include/pjmedia-codec/gsm.h b/pjmedia/include/pjmedia-codec/gsm.h index 7fdff297..1851aa3f 100644 --- a/pjmedia/include/pjmedia-codec/gsm.h +++ b/pjmedia/include/pjmedia-codec/gsm.h @@ -29,7 +29,7 @@ /** * @defgroup PJMED_GSM GSM 06.10 Codec - * @ingroup PJMEDIA_CODEC + * @ingroup PJMEDIA_CODEC_CODECS * @brief Implementation of GSM FR based on GSM 06.10 library * @{ * diff --git a/pjmedia/include/pjmedia-codec/ilbc.h b/pjmedia/include/pjmedia-codec/ilbc.h index 3a40e435..9e4b2d82 100644 --- a/pjmedia/include/pjmedia-codec/ilbc.h +++ b/pjmedia/include/pjmedia-codec/ilbc.h @@ -29,7 +29,7 @@ /** * @defgroup PJMED_ILBC iLBC Codec - * @ingroup PJMEDIA_CODEC + * @ingroup PJMEDIA_CODEC_CODECS * @brief Implementation of iLBC Codec * @{ * diff --git a/pjmedia/include/pjmedia-codec/ipp_codecs.h b/pjmedia/include/pjmedia-codec/ipp_codecs.h index 07ad11cf..16459b3b 100644 --- a/pjmedia/include/pjmedia-codec/ipp_codecs.h +++ b/pjmedia/include/pjmedia-codec/ipp_codecs.h @@ -29,7 +29,7 @@ /** * @defgroup PJMED_IPP_CODEC IPP Codecs - * @ingroup PJMEDIA_CODEC + * @ingroup PJMEDIA_CODEC_CODECS * @brief Implementation of IPP codecs * @{ * diff --git a/pjmedia/include/pjmedia-codec/l16.h b/pjmedia/include/pjmedia-codec/l16.h index 3fca128b..44503c03 100644 --- a/pjmedia/include/pjmedia-codec/l16.h +++ b/pjmedia/include/pjmedia-codec/l16.h @@ -25,7 +25,7 @@ /** * @defgroup PJMED_L16 L16 Codec Family - * @ingroup PJMEDIA_CODEC + * @ingroup PJMEDIA_CODEC_CODECS * @brief PCM/16bit/linear codecs * @{ * diff --git a/pjmedia/include/pjmedia-codec/passthrough.h b/pjmedia/include/pjmedia-codec/passthrough.h index c4f94a91..7a47af1a 100644 --- a/pjmedia/include/pjmedia-codec/passthrough.h +++ b/pjmedia/include/pjmedia-codec/passthrough.h @@ -29,7 +29,7 @@ /** * @defgroup PJMED_PASSTHROUGH_CODEC Passthrough Codecs - * @ingroup PJMEDIA_CODEC + * @ingroup PJMEDIA_CODEC_CODECS * @brief Implementation of passthrough codecs * @{ * diff --git a/pjmedia/include/pjmedia-codec/speex.h b/pjmedia/include/pjmedia-codec/speex.h index fdd14fac..22402e5e 100644 --- a/pjmedia/include/pjmedia-codec/speex.h +++ b/pjmedia/include/pjmedia-codec/speex.h @@ -29,7 +29,7 @@ /** * @defgroup PJMED_SPEEX Speex Codec Family - * @ingroup PJMEDIA_CODEC + * @ingroup PJMEDIA_CODEC_CODECS * @brief Implementation of Speex codecs (narrow/wide/ultrawide-band). * @{ * diff --git a/pjmedia/include/pjmedia-codec/types.h b/pjmedia/include/pjmedia-codec/types.h index dde1371d..f49c4ed2 100644 --- a/pjmedia/include/pjmedia-codec/types.h +++ b/pjmedia/include/pjmedia-codec/types.h @@ -20,9 +20,23 @@ #ifndef __PJMEDIA_CODEC_TYPES_H__ #define __PJMEDIA_CODEC_TYPES_H__ +/** + * @file types.h + * @brief PJMEDIA-CODEC types and constants + */ + #include <pjmedia-codec/config.h> /** + * @defgroup pjmedia_codec_types PJMEDIA-CODEC Types and Constants + * @ingroup PJMEDIA_CODEC + * @brief Constants used by PJMEDIA-CODEC + * @{ + */ + + + +/** * These are the dynamic payload types that are used by codecs in * this library. Also see the header file <pjmedia/codec.h> for list * of static payload types. @@ -71,6 +85,9 @@ enum PJMEDIA_RTP_PT_G7221_RSV2, /**< G722.1 reserve */ }; +/** + * @} + */ #endif /* __PJMEDIA_CODEC_TYPES_H__ */ diff --git a/pjmedia/include/pjmedia/codec.h b/pjmedia/include/pjmedia/codec.h index dcaae626..f0dd77a6 100644 --- a/pjmedia/include/pjmedia/codec.h +++ b/pjmedia/include/pjmedia/codec.h @@ -859,6 +859,20 @@ PJ_DECL(pj_status_t) pjmedia_codec_mgr_dealloc_codec(pjmedia_codec_mgr *mgr, * @} */ +/** + * @defgroup PJMEDIA_CODEC_CODECS Supported codecs + * @ingroup PJMEDIA_CODEC + * @brief Documentation about individual codec supported by PJMEDIA + * @{ + * Please see the APIs provided by the individual codecs below. + */ +/** + * @} + */ + + + + PJ_END_DECL diff --git a/pjmedia/include/pjmedia/g711.h b/pjmedia/include/pjmedia/g711.h index 85f3ed43..2e7fcf1f 100644 --- a/pjmedia/include/pjmedia/g711.h +++ b/pjmedia/include/pjmedia/g711.h @@ -28,8 +28,8 @@ #include <pjmedia-codec/types.h> /** - * @defgroup PJMED_G711 G711 - * @ingroup PJMEDIA_CODEC + * @defgroup PJMED_G711 G711 G.711 Codec + * @ingroup PJMEDIA_CODEC_CODECS * @brief Standard G.711/PCMA and PCMU codec. * @{ * This section describes functions to register and register G.711 codec |