summaryrefslogtreecommitdiff
path: root/modules/g722
diff options
context:
space:
mode:
authorAlfred E. Heggestad <aeh@db.org>2015-06-19 17:37:45 +0200
committerAlfred E. Heggestad <aeh@db.org>2015-06-19 17:37:45 +0200
commitfef6933d984b4a304c2e8f33163e046de54eb2c5 (patch)
treedb475bdcdd94438929af49176e0ff7634cac4739 /modules/g722
parentcad293b46f99fe97a51c7f0f0a6c6d50b51c2437 (diff)
g722: add module documentation
Diffstat (limited to 'modules/g722')
-rw-r--r--modules/g722/g722.c17
1 files changed, 12 insertions, 5 deletions
diff --git a/modules/g722/g722.c b/modules/g722/g722.c
index e68b7bd..bc0fda0 100644
--- a/modules/g722/g722.c
+++ b/modules/g722/g722.c
@@ -12,11 +12,12 @@
#include <spandsp.h>
-/*
- http://www.soft-switch.org/spandsp-modules.html
- */
-
-/* From RFC 3551:
+/**
+ * @defgroup g722 g722
+ *
+ * The G.722 audio codec
+ *
+ * ## From RFC 3551:
4.5.2 G722
@@ -32,8 +33,14 @@
that value was erroneously assigned in RFC 1890 and must remain
unchanged for backward compatibility. The octet rate or sample-pair
rate is 8,000 Hz.
+
+ ## Reference:
+
+ http://www.soft-switch.org/spandsp-modules.html
+
*/
+
enum {
G722_SAMPLE_RATE = 16000,
G722_BITRATE_48k = 48000,