← Back to branch summary

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

« back to all changes in this revision

Viewing changes to sflphone-common/libs/pjproject/pjmedia/include/pjmedia/plc.h

  • Committer: Package Import Robot
  • Author(s): Francois Marier
  • Date: 2011-11-25 13:24:12 UTC
  • mfrom: (4.1.10 sid)
  • Revision ID: package-import@ubuntu.com-20111125132412-dc4qvhyosk74cd42
Tags: 1.0.1-4
http://bugs.debian.org/649726
Don't assume that arch:all packages will get built (closes: #649726)

Show diffs side-by-side

added added

removed removed

Lines of Context:
sflphone-common/libs/pjproject/pjmedia/include/pjmedia/plc.h
1
 
/* $Id: plc.h 2394 2008-12-23 17:27:53Z bennylp $ */
2
 
/* 
3
 
 * Copyright (C) 2008-2009 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
 
 *  Additional permission under GNU GPL version 3 section 7:
21
 
 *
22
 
 *  If you modify this program, or any covered work, by linking or
23
 
 *  combining it with the OpenSSL project's OpenSSL library (or a
24
 
 *  modified version of that library), containing parts covered by the
25
 
 *  terms of the OpenSSL or SSLeay licenses, Teluu Inc. (http://www.teluu.com)
26
 
 *  grants you additional permission to convey the resulting work.
27
 
 *  Corresponding Source for a non-source form of such a combination
28
 
 *  shall include the source code for the parts of OpenSSL used as well
29
 
 *  as that of the covered work.
30
 
 */
31
 
#ifndef __PJMEDIA_PLC_H__
32
 
#define __PJMEDIA_PLC_H__
33
 
 
34
 
 
35
 
/**
36
 
 * @file plc.h
37
 
 * @brief Packet Lost Concealment (PLC) API.
38
 
 */
39
 
#include <pjmedia/types.h>
40
 
 
41
 
/**
42
 
 * @defgroup PJMED_PLC Packet Lost Concealment (PLC)
43
 
 * @ingroup PJMEDIA_FRAME_OP
44
 
 * @brief Packet lost compensation algorithm
45
 
 * @{
46
 
 *
47
 
 * This section describes PJMEDIA's implementation of Packet Lost
48
 
 * Concealment algorithm. This algorithm is used to implement PLC for
49
 
 * codecs that do not have built-in support for one (e.g. G.711 or GSM 
50
 
 * codecs).
51
 
 *
52
 
 * The PLC algorithm (either built-in or external) is embedded in
53
 
 * PJMEDIA codec instance, and application can conceal lost frames
54
 
 * by calling <b><tt>recover()</tt></b> member of the codec's member
55
 
 * operation (#pjmedia_codec_op).
56
 
 *
57
 
 * See also @ref plc_codec for more info.
58
 
 */
59
 
 
60
 
 
61
 
PJ_BEGIN_DECL
62
 
 
63
 
 
64
 
/**
65
 
 * Opaque declaration for PLC.
66
 
 */
67
 
typedef struct pjmedia_plc pjmedia_plc;
68
 
 
69
 
 
70
 
 
71
 
/**
72
 
 * Create PLC session. This function will select the PLC algorithm to
73
 
 * use based on the arguments.
74
 
 *
75
 
 * @param pool              Pool to allocate memory for the PLC.
76
 
 * @param clock_rate        Media sampling rate.
77
 
 * @param samples_per_frame Number of samples per frame.
78
 
 * @param options           Must be zero for now.
79
 
 * @param p_plc             Pointer to receive the PLC instance.
80
 
 *
81
 
 * @return                  PJ_SUCCESS on success.
82
 
 */
83
 
PJ_DECL(pj_status_t) pjmedia_plc_create( pj_pool_t *pool,
84
 
                                         unsigned clock_rate,
85
 
                                         unsigned samples_per_frame,
86
 
                                         unsigned options,
87
 
                                         pjmedia_plc **p_plc);
88
 
 
89
 
 
90
 
/**
91
 
 * Save a good frame to PLC.
92
 
 *
93
 
 * @param plc               The PLC session.
94
 
 * @param frame             The good frame to be stored to PLC. This frame
95
 
 *                          must have the same length as the configured
96
 
 *                          samples per frame.
97
 
 *
98
 
 * @return                  PJ_SUCCESS on success.
99
 
 */
100
 
PJ_DECL(pj_status_t) pjmedia_plc_save( pjmedia_plc *plc,
101
 
                                       pj_int16_t *frame );
102
 
 
103
 
 
104
 
/**
105
 
 * Generate a replacement for lost frame.
106
 
 *
107
 
 * @param plc               The PLC session.
108
 
 * @param frame             Buffer to receive the generated frame. This buffer
109
 
 *                          must be able to store the frame.
110
 
 *
111
 
 * @return                  PJ_SUCCESS on success.
112
 
 */
113
 
PJ_DECL(pj_status_t) pjmedia_plc_generate( pjmedia_plc *plc,
114
 
                                           pj_int16_t *frame );
115
 
 
116
 
 
117
 
 
118
 
 
119
 
PJ_END_DECL
120
 
 
121
 
/**
122
 
 * @}
123
 
 */
124
 
 
125
 
#endif  /* __PJMEDIA_PLC_H__ */
126