| Tristan Matthews | 0a329cc | 2013-07-17 13:20:14 -0400 | [diff] [blame] | 1 | /* $Id$ */ |
| 2 | /* |
| 3 | * Copyright (C) 2008-2011 Teluu Inc. (http://www.teluu.com) |
| 4 | * Copyright (C) 2003-2008 Benny Prijono <benny@prijono.org> |
| 5 | * |
| 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. |
| 10 | * |
| 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. |
| 15 | * |
| 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 |
| 19 | */ |
| 20 | #ifndef __PJMEDIA_G711_H__ |
| 21 | #define __PJMEDIA_G711_H__ |
| 22 | |
| 23 | /** |
| 24 | * @file g711.h |
| 25 | * @brief G711 Codec |
| 26 | */ |
| 27 | |
| 28 | #include <pjmedia-codec/types.h> |
| 29 | |
| 30 | /** |
| 31 | * @defgroup PJMED_G711 G.711 Codec |
| 32 | * @ingroup PJMEDIA_CODEC_CODECS |
| 33 | * @brief Standard G.711/PCMA and PCMU codec. |
| 34 | * @{ |
| 35 | * |
| 36 | * This section describes functions to initialize and register G.711 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. |
| 39 | * |
| 40 | * The G.711 is an ultra low complexity codecs and in trade-off it results |
| 41 | * in high bitrate, i.e: 64kbps for 16-bit PCM with sampling rate 8000Hz. |
| 42 | * |
| 43 | * The factory contains two main compression algorithms, PCMU/u-Law and |
| 44 | * PCMA/A-Law. |
| 45 | * |
| 46 | * \section codec_setting Codec Settings |
| 47 | * |
| 48 | * \subsection general_setting General Settings |
| 49 | * |
| 50 | * General codec settings for this codec such as VAD and PLC can be |
| 51 | * manipulated through the <tt>setting</tt> field in #pjmedia_codec_param. |
| 52 | * Please see the documentation of #pjmedia_codec_param for more info. |
| 53 | * |
| 54 | * \subsection specific_setting Codec Specific Settings |
| 55 | * |
| 56 | * Currently none. |
| 57 | */ |
| 58 | |
| 59 | PJ_BEGIN_DECL |
| 60 | |
| 61 | |
| 62 | /** |
| 63 | * Initialize and register G711 codec factory to pjmedia endpoint. |
| 64 | * This will register PCMU and PCMA codec, in that order. |
| 65 | * |
| 66 | * @param endpt The pjmedia endpoint. |
| 67 | * |
| 68 | * @return PJ_SUCCESS on success. |
| 69 | */ |
| 70 | PJ_DECL(pj_status_t) pjmedia_codec_g711_init(pjmedia_endpt *endpt); |
| 71 | |
| 72 | |
| 73 | |
| 74 | /** |
| 75 | * Unregister G711 codec factory from pjmedia endpoint. |
| 76 | * |
| 77 | * @return PJ_SUCCESS on success. |
| 78 | */ |
| 79 | PJ_DECL(pj_status_t) pjmedia_codec_g711_deinit(void); |
| 80 | |
| 81 | |
| 82 | PJ_END_DECL |
| 83 | |
| 84 | /** |
| 85 | * @} |
| 86 | */ |
| 87 | |
| 88 | #endif /* __PJMEDIA_G711_H__ */ |
| 89 | |