pjsip-pjproject/pjmedia/include/pjmedia-codec/gsm.h

87 lines
2.4 KiB
C

/*
* Copyright (C) 2008-2011 Teluu Inc. (http://www.teluu.com)
* Copyright (C) 2003-2008 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_GSM_H__
#define __PJMEDIA_CODEC_GSM_H__
/**
* @file pjmedia-codec/gsm.h
* @brief GSM 06.10 codec.
*/
#include <pjmedia-codec/types.h>
/**
* @defgroup PJMED_GSM GSM 06.10 Codec
* @ingroup PJMEDIA_CODEC_CODECS
* @brief Implementation of GSM FR based on GSM 06.10 library
* @{
*
* This section describes functions to initialize and register GSM 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 GSM codec supports 16-bit PCM with sampling rate of 8000Hz resulting
* in 13.2kbps bitrate.
*
* \section gsm_codec_setting Codec Settings
*
* \subsection gsm_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 gsm_specific_setting Codec Specific Settings
*
* Currently none.
*/
PJ_BEGIN_DECL
/**
* Initialize and register GSM codec factory to pjmedia endpoint.
*
* @param endpt The pjmedia endpoint.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t) pjmedia_codec_gsm_init( pjmedia_endpt *endpt );
/**
* Unregister GSM codec factory from pjmedia endpoint and deinitialize
* the GSM codec library.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t) pjmedia_codec_gsm_deinit(void);
PJ_END_DECL
/**
* @}
*/
#endif /* __PJMEDIA_CODEC_GSM_H__ */