~ubuntu-branches/ubuntu/wily/sflphone/wily

« back to all changes in this revision

Viewing changes to daemon/libs/pjproject-2.1.0/pjmedia/include/pjmedia-codec/g722.h

  • Committer: Package Import Robot
  • Author(s): Jonathan Riddell
  • Date: 2015-01-07 14:51:16 UTC
  • mfrom: (4.3.5 sid)
  • Revision ID: package-import@ubuntu.com-20150107145116-yxnafinf4lrdvrmx
Tags: 1.4.1-0.1ubuntu1
* Merge with Debian, remaining changes:
 - Drop soprano, nepomuk build-dep
* Drop ubuntu patches, now upstream

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
/* $Id: g722.h 3553 2011-05-05 06:14:19Z nanang $ */
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_CODEC_G722_H__
21
 
#define __PJMEDIA_CODEC_G722_H__
22
 
 
23
 
/**
24
 
 * @file pjmedia-codec/g722.h
25
 
 * @brief G.722 codec.
26
 
 */
27
 
 
28
 
#include <pjmedia-codec/types.h>
29
 
 
30
 
/**
31
 
 * @defgroup PJMED_G722 G.722 Codec
32
 
 * @ingroup PJMEDIA_CODEC_CODECS
33
 
 * @brief Implementation of G.722 Codec
34
 
 * @{
35
 
 *
36
 
 * This section describes functions to initialize and register G.722 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.722 implementation uses 16-bit PCM with sampling rate 16000Hz and 
41
 
 * 20ms frame length resulting in 64kbps bitrate.
42
 
 *
43
 
 * The G.722 codec implementation is provided as part of pjmedia-codec
44
 
 * library, and does not depend on external G.722 codec implementation.
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 G.722 codec factory to pjmedia endpoint.
64
 
 *
65
 
 * @param endpt     The pjmedia endpoint.
66
 
 *
67
 
 * @return          PJ_SUCCESS on success.
68
 
 */
69
 
PJ_DECL(pj_status_t) pjmedia_codec_g722_init(pjmedia_endpt *endpt);
70
 
 
71
 
 
72
 
/**
73
 
 * Unregister G.722 codec factory from pjmedia endpoint and cleanup
74
 
 * resources allocated by the factory.
75
 
 *
76
 
 * @return          PJ_SUCCESS on success.
77
 
 */
78
 
PJ_DECL(pj_status_t) pjmedia_codec_g722_deinit(void);
79
 
 
80
 
 
81
 
/**
82
 
 * Set the G.722 codec encoder and decoder level adjustment.
83
 
 * If the value is non-zero, then PCM input samples to the encoder will 
84
 
 * be shifted right by this value, and similarly PCM output samples from
85
 
 * the decoder will be shifted left by this value.
86
 
 *
87
 
 * Default value is PJMEDIA_G722_DEFAULT_PCM_SHIFT.
88
 
 *
89
 
 * @param val           The value
90
 
 *
91
 
 * @return              PJ_SUCCESS on success.
92
 
 */
93
 
PJ_DECL(pj_status_t) pjmedia_codec_g722_set_pcm_shift(unsigned val);
94
 
 
95
 
 
96
 
PJ_END_DECL
97
 
 
98
 
 
99
 
/**
100
 
 * @}
101
 
 */
102
 
 
103
 
#endif /* __PJMEDIA_CODEC_G722_H__ */
104