1
/* $Id: gsm.h 3553 2011-05-05 06:14:19Z nanang $ */
3
* Copyright (C) 2008-2011 Teluu Inc. (http://www.teluu.com)
4
* Copyright (C) 2003-2008 Benny Prijono <benny@prijono.org>
6
* This program is free software; you can redistribute it and/or modify
7
* it under the terms of the GNU General Public License as published by
8
* the Free Software Foundation; either version 2 of the License, or
9
* (at your option) any later version.
11
* This program is distributed in the hope that it will be useful,
12
* but WITHOUT ANY WARRANTY; without even the implied warranty of
13
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14
* GNU General Public License for more details.
16
* You should have received a copy of the GNU General Public License
17
* along with this program; if not, write to the Free Software
18
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20
#ifndef __PJMEDIA_CODEC_GSM_H__
21
#define __PJMEDIA_CODEC_GSM_H__
24
* @file pjmedia-codec/gsm.h
25
* @brief GSM 06.10 codec.
28
#include <pjmedia-codec/types.h>
31
* @defgroup PJMED_GSM GSM 06.10 Codec
32
* @ingroup PJMEDIA_CODEC_CODECS
33
* @brief Implementation of GSM FR based on GSM 06.10 library
36
* This section describes functions to initialize and register GSM codec
37
* factory to the codec manager. After the codec factory has been registered,
38
* application can use @ref PJMEDIA_CODEC API to manipulate the codec.
40
* The GSM codec supports 16-bit PCM with sampling rate of 8000Hz resulting
41
* in 13.2kbps bitrate.
43
* \section codec_setting Codec Settings
45
* \subsection general_setting General Settings
47
* General codec settings for this codec such as VAD and PLC can be
48
* manipulated through the <tt>setting</tt> field in #pjmedia_codec_param.
49
* Please see the documentation of #pjmedia_codec_param for more info.
51
* \subsection specific_setting Codec Specific Settings
60
* Initialize and register GSM codec factory to pjmedia endpoint.
62
* @param endpt The pjmedia endpoint.
64
* @return PJ_SUCCESS on success.
66
PJ_DECL(pj_status_t) pjmedia_codec_gsm_init( pjmedia_endpt *endpt );
71
* Unregister GSM codec factory from pjmedia endpoint and deinitialize
72
* the GSM codec library.
74
* @return PJ_SUCCESS on success.
76
PJ_DECL(pj_status_t) pjmedia_codec_gsm_deinit(void);
86
#endif /* __PJMEDIA_CODEC_GSM_H__ */