summaryrefslogtreecommitdiff
path: root/pjmedia/include/pjmedia-codec/speex.h
diff options
context:
space:
mode:
Diffstat (limited to 'pjmedia/include/pjmedia-codec/speex.h')
-rw-r--r--pjmedia/include/pjmedia-codec/speex.h87
1 files changed, 87 insertions, 0 deletions
diff --git a/pjmedia/include/pjmedia-codec/speex.h b/pjmedia/include/pjmedia-codec/speex.h
new file mode 100644
index 00000000..a6e76808
--- /dev/null
+++ b/pjmedia/include/pjmedia-codec/speex.h
@@ -0,0 +1,87 @@
+/* $Id$ */
+/*
+ * Copyright (C)2003-2006 Benny Prijono <benny@prijono.org>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ */
+#ifndef __PJMEDIA_CODEC_SPEEX_H__
+#define __PJMEDIA_CODEC_SPEEX_H__
+
+#include <pjmedia-codec/types.h>
+
+
+PJ_BEGIN_DECL
+
+
+/**
+ * Bitmask options to be passed during Speex codec factory initialization.
+ */
+enum pjmedia_speex_options
+{
+ PJMEDIA_SPEEX_NO_NB = 1, /**< Disable narrowband mode. */
+ PJMEDIA_SPEEX_NO_WB = 2, /**< Disable wideband mode. */
+ PJMEDIA_SPEEX_NO_UWB = 4, /**< Disable ultra-wideband mode. */
+};
+
+
+/**
+ * Initialize and register Speex codec factory to pjmedia endpoint.
+ *
+ * @param endpt The pjmedia endpoint.
+ * @param options Bitmask of pjmedia_speex_options (default=0).
+ * @param quality Specify encoding quality, or use -1 for default
+ * (default=8).
+ * @param complexity Specify encoding complexity , or use -1 for default
+ * (default=8).
+ *
+ * @return PJ_SUCCESS on success.
+ */
+PJ_DECL(pj_status_t) pjmedia_codec_speex_init( pjmedia_endpt *endpt,
+ unsigned options,
+ int quality,
+ int complexity );
+
+
+/**
+ * Initialize Speex codec factory using default settings and register to
+ * pjmedia endpoint.
+ *
+ * @param endpt The pjmedia endpoint.
+ * @param options Bitmask of pjmedia_speex_options (default=0).
+ * @param quality Specify encoding quality, or use -1 for default
+ * (default=8).
+ * @param complexity Specify encoding complexity , or use -1 for default
+ * (default=8).
+ *
+ * @return PJ_SUCCESS on success.
+ */
+PJ_DECL(pj_status_t) pjmedia_codec_speex_init_default(pjmedia_endpt *endpt);
+
+
+
+/**
+ * Unregister Speex codec factory from pjmedia endpoint and deinitialize
+ * the Speex codec library.
+ *
+ * @return PJ_SUCCESS on success.
+ */
+PJ_DECL(pj_status_t) pjmedia_codec_speex_deinit(void);
+
+
+PJ_END_DECL
+
+
+#endif /* __PJMEDIA_CODEC_SPEEX_H__ */
+