-
Notifications
You must be signed in to change notification settings - Fork 25
Expand file tree
/
Copy pathEncoder.java
More file actions
274 lines (237 loc) · 8.74 KB
/
Copy pathEncoder.java
File metadata and controls
274 lines (237 loc) · 8.74 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
/******************************************************************************
* *
* Copyright (c) 1999-2003 Wimba S.A., All Rights Reserved. *
* *
* COPYRIGHT: *
* This software is the property of Wimba S.A. *
* This software is redistributed under the Xiph.org variant of *
* the BSD license. *
* Redistribution and use in source and binary forms, with or without *
* modification, are permitted provided that the following conditions *
* are met: *
* - Redistributions of source code must retain the above copyright *
* notice, this list of conditions and the following disclaimer. *
* - Redistributions in binary form must reproduce the above copyright *
* notice, this list of conditions and the following disclaimer in the *
* documentation and/or other materials provided with the distribution. *
* - Neither the name of Wimba, the Xiph.org Foundation nor the names of *
* its contributors may be used to endorse or promote products derived *
* from this software without specific prior written permission. *
* *
* WARRANTIES: *
* This software is made available by the authors in the hope *
* that it will be useful, but without any warranty. *
* Wimba S.A. is not liable for any consequence related to the *
* use of the provided software. *
* *
* Class: Encoder.java *
* *
* Author: Marc GIMPEL *
* Based on code by: Jean-Marc VALIN *
* *
* Date: 9th April 2003 *
* *
******************************************************************************/
/* $Id$ */
/* Copyright (C) 2002 Jean-Marc Valin
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
- Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
- Neither the name of the Xiph.org Foundation nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package javaforce.codec.speex;
/**
* Speex Encoder interface, used as a base for the Narrowband and sideband
* encoders.
*
* @author Marc Gimpel, Wimba S.A. ([email protected])
* @version $Revision$
*/
public interface Encoder {
/**
* Encode the given input signal.
*
* @param bits - Speex bits buffer.
* @param in - the raw mono audio frame to encode.
* @return 1 if successful.
*/
public int encode(Bits bits, float[] in);
/**
* Returns the size in bits of an audio frame encoded with the current mode.
*
* @return the size in bits of an audio frame encoded with the current mode.
*/
public int getEncodedFrameSize();
//--------------------------------------------------------------------------
// Speex Control Functions
//--------------------------------------------------------------------------
/**
* Returns the size of a frame.
*
* @return the size of a frame.
*/
public int getFrameSize();
/**
* Sets the Quality (between 0 and 10).
*
* @param quality - the desired Quality (between 0 and 10).
*/
public void setQuality(int quality);
/**
* Get the current Bit Rate.
*
* @return the current Bit Rate.
*/
public int getBitRate();
// public void resetState();
/**
* Returns the Pitch Gain array.
*
* @return the Pitch Gain array.
*/
public float[] getPiGain();
/**
* Returns the excitation array.
*
* @return the excitation array.
*/
public float[] getExc();
/**
* Returns the innovation array.
*
* @return the innovation array.
*/
public float[] getInnov();
/**
* Sets the encoding submode.
*
* @param mode
*/
public void setMode(int mode);
/**
* Returns the encoding submode currently in use.
*
* @return the encoding submode currently in use.
*/
public int getMode();
/**
* Sets the bitrate.
*
* @param bitrate
*/
public void setBitRate(int bitrate);
/**
* Sets whether or not to use Variable Bit Rate encoding.
*
* @param vbr
*/
public void setVbr(boolean vbr);
/**
* Returns whether or not we are using Variable Bit Rate encoding.
*
* @return whether or not we are using Variable Bit Rate encoding.
*/
public boolean getVbr();
/**
* Sets whether or not to use Voice Activity Detection encoding.
*
* @param vad
*/
public void setVad(boolean vad);
/**
* Returns whether or not we are using Voice Activity Detection encoding.
*
* @return whether or not we are using Voice Activity Detection encoding.
*/
public boolean getVad();
/**
* Sets whether or not to use Discontinuous Transmission encoding.
*
* @param dtx
*/
public void setDtx(boolean dtx);
/**
* Returns whether or not we are using Discontinuous Transmission encoding.
*
* @return whether or not we are using Discontinuous Transmission encoding.
*/
public boolean getDtx();
/**
* Returns the Average Bit Rate used (0 if ABR is not turned on).
*
* @return the Average Bit Rate used (0 if ABR is not turned on).
*/
public int getAbr();
/**
* Sets the Average Bit Rate.
*
* @param abr - the desired Average Bit Rate.
*/
public void setAbr(int abr);
/**
* Sets the Varible Bit Rate Quality.
*
* @param quality - the desired Varible Bit Rate Quality.
*/
public void setVbrQuality(float quality);
/**
* Returns the Varible Bit Rate Quality.
*
* @return the Varible Bit Rate Quality.
*/
public float getVbrQuality();
/**
* Sets the algorithmic complexity.
*
* @param complexity - the desired algorithmic complexity (between 1 and 10 - default is 3).
*/
public void setComplexity(int complexity);
/**
* Returns the algorthmic complexity.
*
* @return the algorthmic complexity.
*/
public int getComplexity();
/**
* Sets the sampling rate.
*
* @param rate - the sampling rate.
*/
public void setSamplingRate(int rate);
/**
* Returns the sampling rate.
*
* @return the sampling rate.
*/
public int getSamplingRate();
/**
* Return LookAhead.
*
* @return LookAhead.
*/
public int getLookAhead();
/**
* Returns the relative quality.
*
* @return the relative quality.
*/
public float getRelativeQuality();
}