← Back to branch summary

~ubuntu-branches/debian/stretch/sflphone/stretch

« back to all changes in this revision

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

  • Committer: Package Import Robot
  • Author(s): Francois Marier, Francois Marier, Mark Purcell
  • Date: 2014-10-18 15:08:50 UTC
  • mfrom: (1.1.12)
  • Revision ID: package-import@ubuntu.com-20141018150850-2exfk34ckb15pcwi
Tags: 1.4.1-0.1
http://bugs.debian.org/759576
http://bugs.debian.org/741130
[ Francois Marier ]
* Non-maintainer upload
* New upstream release (closes: #759576, #741130)
  - debian/rules +PJPROJECT_VERSION := 2.2.1
  - add upstream patch to fix broken TLS support
  - add patch to fix pjproject regression

[ Mark Purcell ]
* Build-Depends:
  - sflphone-daemon + libavformat-dev, libavcodec-dev, libswscale-dev,
  libavdevice-dev, libavutil-dev
  - sflphone-gnome + libclutter-gtk-1.0-dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
daemon/libs/pjproject-2.1.0/pjmedia/include/pjmedia/wsola.h
1
 
/* $Id: wsola.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_WSOLA_H__
21
 
#define __PJMEDIA_WSOLA_H__
22
 
 
23
 
/**
24
 
 * @file wsola.h
25
 
 * @brief Waveform Similarity Based Overlap-Add (WSOLA)
26
 
 */
27
 
#include <pjmedia/types.h>
28
 
 
29
 
/**
30
 
 * @defgroup PJMED_WSOLA Waveform Similarity Based Overlap-Add (WSOLA)
31
 
 * @ingroup PJMEDIA_FRAME_OP
32
 
 * @brief Time-scale modification to audio without affecting the pitch
33
 
 * @{
34
 
 *
35
 
 * This section describes Waveform Similarity Based Overlap-Add (WSOLA)
36
 
 * implementation in PJMEDIA. The WSOLA API here can be used both to 
37
 
 * compress (speed-up) and stretch (expand, slow down) audio playback
38
 
 * without altering the pitch, or as a mean for performing packet loss
39
 
 * concealment (WSOLA).
40
 
 *
41
 
 * The WSOLA implementation is used by \ref PJMED_DELAYBUF and \ref PJMED_PLC.
42
 
 */
43
 
 
44
 
PJ_BEGIN_DECL
45
 
 
46
 
 
47
 
/**
48
 
 * Opaque declaration for WSOLA structure.
49
 
 */
50
 
typedef struct pjmedia_wsola pjmedia_wsola;
51
 
 
52
 
 
53
 
/**
54
 
 * WSOLA options, can be combined with bitmask operation.
55
 
 */
56
 
enum pjmedia_wsola_option
57
 
{
58
 
    /**
59
 
     * Disable Hanning window to conserve memory.
60
 
     */
61
 
    PJMEDIA_WSOLA_NO_HANNING    = 1,
62
 
 
63
 
    /**
64
 
     * Specify that the WSOLA will not be used for PLC.
65
 
     */
66
 
    PJMEDIA_WSOLA_NO_PLC = 2,
67
 
 
68
 
    /**
69
 
     * Specify that the WSOLA will not be used to discard frames in
70
 
     * non-contiguous buffer.
71
 
     */
72
 
    PJMEDIA_WSOLA_NO_DISCARD = 4,
73
 
 
74
 
    /**
75
 
     * Disable fade-in and fade-out feature in the transition between
76
 
     * actual and synthetic frames in WSOLA. With fade feature enabled, 
77
 
     * WSOLA will only generate a limited number of synthetic frames 
78
 
     * (configurable with #pjmedia_wsola_set_max_expand()), fading out 
79
 
     * the volume on every more samples it generates, and when it reaches
80
 
     * the limit it will only generate silence.
81
 
     */
82
 
    PJMEDIA_WSOLA_NO_FADING = 8
83
 
};
84
 
 
85
 
 
86
 
 
87
 
/**
88
 
 * Create and initialize WSOLA.
89
 
 *
90
 
 * @param pool              Pool to allocate memory for WSOLA.
91
 
 * @param clock_rate        Sampling rate of audio playback.
92
 
 * @param samples_per_frame Number of samples per frame.
93
 
 * @param channel_count     Number of channels.
94
 
 * @param options           Option flags, bitmask combination of
95
 
 *                          #pjmedia_wsola_option.
96
 
 * @param p_wsola           Pointer to receive WSOLA structure.
97
 
 *
98
 
 * @return                  PJ_SUCCESS or the appropriate error code.
99
 
 */
100
 
PJ_DECL(pj_status_t) pjmedia_wsola_create(pj_pool_t *pool, 
101
 
                                          unsigned clock_rate,
102
 
                                          unsigned samples_per_frame,
103
 
                                          unsigned channel_count,
104
 
                                          unsigned options,
105
 
                                          pjmedia_wsola **p_wsola);
106
 
 
107
 
 
108
 
/**
109
 
 * Specify maximum number of continuous synthetic frames that can be
110
 
 * generated by WSOLA, in milliseconds. This option will only take
111
 
 * effect if fading is not disabled via the option when the WSOLA
112
 
 * session was created. Default value is PJMEDIA_WSOLA_MAX_EXPAND_MSEC
113
 
 * (see also the documentation of PJMEDIA_WSOLA_MAX_EXPAND_MSEC for
114
 
 * more information).
115
 
 *
116
 
 * @param wsola     The WSOLA session
117
 
 * @param msec      The duration.
118
 
 *
119
 
 * @return          PJ_SUCCESS normally.
120
 
 */
121
 
PJ_DECL(pj_status_t) pjmedia_wsola_set_max_expand(pjmedia_wsola *wsola,
122
 
                                                  unsigned msec);
123
 
 
124
 
 
125
 
/**
126
 
 * Destroy WSOLA.
127
 
 *
128
 
 * @param wsola     WSOLA session.
129
 
 *
130
 
 * @return          PJ_SUCCESS normally.
131
 
 */
132
 
PJ_DECL(pj_status_t) pjmedia_wsola_destroy(pjmedia_wsola *wsola);
133
 
 
134
 
 
135
 
/**
136
 
 * Reset the buffer contents of WSOLA.
137
 
 *
138
 
 * @param wsola     WSOLA session.
139
 
 * @param options   Reset options, must be zero for now.
140
 
 *
141
 
 * @return          PJ_SUCCESS normally.
142
 
 */
143
 
PJ_DECL(pj_status_t) pjmedia_wsola_reset(pjmedia_wsola *wsola,
144
 
                                         unsigned options);
145
 
 
146
 
 
147
 
/**
148
 
 * Give one good frame to WSOLA to be kept as reference. Application
149
 
 * must continuously give WSOLA good frames to keep its session up to
150
 
 * date with current playback. Depending on the WSOLA implementation,
151
 
 * this function may modify the content of the frame.
152
 
 *
153
 
 * @param wsola     WSOLA session.
154
 
 * @param frm       The frame, which length must match the samples per
155
 
 *                  frame setting of the WSOLA session.
156
 
 * @param prev_lost If application previously generated a synthetic
157
 
 *                  frame with #pjmedia_wsola_generate() before calling
158
 
 *                  this function, specify whether that was because of
159
 
 *                  packet lost. If so, set this parameter to PJ_TRUE
160
 
 *                  to make WSOLA interpolate this frame with its buffer.
161
 
 *                  Otherwise if this value is PJ_FALSE, WSOLA will
162
 
 *                  just append this frame to the end of its buffer.
163
 
 *
164
 
 * @return          PJ_SUCCESS normally.
165
 
 */
166
 
PJ_DECL(pj_status_t) pjmedia_wsola_save(pjmedia_wsola *wsola, 
167
 
                                        pj_int16_t frm[], 
168
 
                                        pj_bool_t prev_lost);
169
 
 
170
 
/**
171
 
 * Generate one synthetic frame from WSOLA.
172
 
 *
173
 
 * @param wsola     WSOLA session.
174
 
 * @param frm       Buffer to receive the frame.
175
 
 *
176
 
 * @return          PJ_SUCCESS normally.
177
 
 */
178
 
PJ_DECL(pj_status_t) pjmedia_wsola_generate(pjmedia_wsola *wsola, 
179
 
                                            pj_int16_t frm[]);
180
 
 
181
 
 
182
 
/**
183
 
 * Compress or compact the specified buffer by removing some audio samples
184
 
 * from the buffer, without altering the pitch. For this function to work, 
185
 
 * total length of the buffer must be more than twice \a erase_cnt.
186
 
 * 
187
 
 * @param wsola     WSOLA session.
188
 
 * @param buf1      Pointer to buffer. 
189
 
 * @param buf1_cnt  Number of samples in the buffer.
190
 
 * @param buf2      Pointer to second buffer, if the buffer is not
191
 
 *                  contiguous. Otherwise this parameter must be NULL.
192
 
 * @param buf2_cnt  Number of samples in the second buffer, if the buffer
193
 
 *                  is not contiguous. Otherwise this parameter should be
194
 
 *                  zero.
195
 
 * @param erase_cnt On input, specify the number of samples to be erased.
196
 
 *                  This function may erase more or less than the requested 
197
 
 *                  number, and the actual number of samples erased will be 
198
 
 *                  given on this argument upon returning from the function.
199
 
 *
200
 
 * @return          PJ_SUCCESS if some samples have been erased, PJ_ETOOSMALL
201
 
 *                  if buffer is too small to be reduced, PJ_EINVAL if any
202
 
 *                  of the parameters are not valid.
203
 
 */
204
 
PJ_DECL(pj_status_t) pjmedia_wsola_discard(pjmedia_wsola *wsola, 
205
 
                                           pj_int16_t buf1[],
206
 
                                           unsigned buf1_cnt, 
207
 
                                           pj_int16_t buf2[],
208
 
                                           unsigned buf2_cnt,
209
 
                                           unsigned *erase_cnt);
210
 
 
211
 
 
212
 
PJ_END_DECL
213
 
 
214
 
/**
215
 
 * @}
216
 
 */
217
 
 
218
 
#endif  /* __PJMEDIA_WSOLA_H__ */
219