upstream version 1.2.2
[debian/freetts] / javadoc / com / sun / speech / freetts / util / WaveUtils.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">\r
2 <!--NewPage-->\r
3 <HTML>\r
4 <HEAD>\r
5 <!-- Generated by javadoc (build 1.4.2_16) on Mon Mar 09 18:20:31 CET 2009 -->\r
6 <TITLE>\r
7 WaveUtils (FreeTTS 1.2)\r
8 </TITLE>\r
9 \r
10 <META NAME="keywords" CONTENT="com.sun.speech.freetts.util.WaveUtils class">\r
11 \r
12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">\r
13 \r
14 <SCRIPT type="text/javascript">\r
15 function windowTitle()\r
16 {\r
17     parent.document.title="WaveUtils (FreeTTS 1.2)";\r
18 }\r
19 </SCRIPT>\r
20 \r
21 </HEAD>\r
22 \r
23 <BODY BGCOLOR="white" onload="windowTitle();">\r
24 \r
25
26 <!-- ========= START OF TOP NAVBAR ======= -->\r
27 <A NAME="navbar_top"><!-- --></A>
28 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
29 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
30 <TR>\r
31 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
32 <A NAME="navbar_top_firstrow"><!-- --></A>
33 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
34   <TR ALIGN="center" VALIGN="top">\r
35   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
36   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
37   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
38   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
39   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
40   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
41   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
42   </TR>\r
43 </TABLE>\r
44 </TD>\r
45 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
46 </EM>\r
47 </TD>\r
48 </TR>\r
49 \r
50 <TR>\r
51 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
52 &nbsp;<A HREF="../../../../../com/sun/speech/freetts/util/Utilities.html" title="class in com.sun.speech.freetts.util"><B>PREV CLASS</B></A>&nbsp;\r
53 &nbsp;NEXT CLASS</FONT></TD>\r
54 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
55   <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
56 &nbsp;<A HREF="WaveUtils.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
57 &nbsp;<SCRIPT type="text/javascript">\r
58   <!--\r
59   if(window==top) {\r
60     document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
61   }\r
62   //-->\r
63 </SCRIPT>\r
64 <NOSCRIPT>\r
65   <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>\r
66 </NOSCRIPT>
67 \r
68 </FONT></TD>\r
69 </TR>\r
70 <TR>\r
71 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
72   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
73 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
74 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
75 </TR>\r
76 </TABLE>\r
77 <A NAME="skip-navbar_top"></A>
78 <!-- ========= END OF TOP NAVBAR ========= -->\r
79 \r
80 <HR>\r
81 <!-- ======== START OF CLASS DATA ======== -->\r
82 <H2>\r
83 <FONT SIZE="-1">\r
84 com.sun.speech.freetts.util</FONT>\r
85 <BR>\r
86 Class WaveUtils</H2>\r
87 <PRE>\r
88 java.lang.Object\r
89   <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>com.sun.speech.freetts.util.WaveUtils</B>\r
90 </PRE>\r
91 <HR>\r
92 <DL>\r
93 <DT>public class <B>WaveUtils</B><DT>extends java.lang.Object</DL>\r
94 \r
95 <P>\r
96 Provides a set of utilities for prrocessing wave/audio data.\r
97 <P>\r
98 \r
99 <P>\r
100 <HR>\r
101 \r
102 <P>\r
103 <!-- ======== NESTED CLASS SUMMARY ======== -->\r
104 \r
105 \r
106 <!-- =========== FIELD SUMMARY =========== -->\r
107 \r
108 \r
109 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
110 \r
111 <A NAME="constructor_summary"><!-- --></A>
112 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
113 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
114 <TD COLSPAN=2><FONT SIZE="+2">\r
115 <B>Constructor Summary</B></FONT></TD>\r
116 </TR>\r
117 <TR BGCOLOR="white" CLASS="TableRowColor">\r
118 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/util/WaveUtils.html#WaveUtils()">WaveUtils</A></B>()</CODE>\r
119 \r
120 <BR>\r
121 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
122 </TR>\r
123 </TABLE>\r
124 &nbsp;\r
125 <!-- ========== METHOD SUMMARY =========== -->\r
126 \r
127 <A NAME="method_summary"><!-- --></A>
128 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
129 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
130 <TD COLSPAN=2><FONT SIZE="+2">\r
131 <B>Method Summary</B></FONT></TD>\r
132 </TR>\r
133 <TR BGCOLOR="white" CLASS="TableRowColor">\r
134 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
135 <CODE>static&nbsp;short</CODE></FONT></TD>\r
136 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/util/WaveUtils.html#bytesToShort(byte, byte)">bytesToShort</A></B>(byte&nbsp;hiByte,
137              byte&nbsp;loByte)</CODE>\r
138 \r
139 <BR>\r
140 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reconstructs a short from its hi and low bytes.</TD>\r
141 </TR>\r
142 <TR BGCOLOR="white" CLASS="TableRowColor">\r
143 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
144 <CODE>static&nbsp;void</CODE></FONT></TD>\r
145 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/util/WaveUtils.html#main(java.lang.String[])">main</A></B>(java.lang.String[]&nbsp;args)</CODE>\r
146 \r
147 <BR>\r
148 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Provides test program for method ulawToShort().</TD>\r
149 </TR>\r
150 <TR BGCOLOR="white" CLASS="TableRowColor">\r
151 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
152 <CODE>static&nbsp;byte</CODE></FONT></TD>\r
153 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/util/WaveUtils.html#shortToUlaw(short)">shortToUlaw</A></B>(short&nbsp;sampleData)</CODE>\r
154 \r
155 <BR>\r
156 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Converts a raw short to ulaw.</TD>\r
157 </TR>\r
158 <TR BGCOLOR="white" CLASS="TableRowColor">\r
159 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
160 <CODE>static&nbsp;short</CODE></FONT></TD>\r
161 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/util/WaveUtils.html#ulawToShort(short)">ulawToShort</A></B>(short&nbsp;uByte)</CODE>\r
162 \r
163 <BR>\r
164 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Converts from ulaw to 16 bit linear.
165  </TD>\r
166 </TR>\r
167 </TABLE>\r
168 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
169 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
170 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
171 <TD><B>Methods inherited from class java.lang.Object</B></TD>\r
172 </TR>\r
173 <TR BGCOLOR="white" CLASS="TableRowColor">\r
174 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>\r
175 </TR>\r
176 </TABLE>\r
177 &nbsp;\r
178 <P>\r
179 \r
180 <!-- ============ FIELD DETAIL =========== -->\r
181 \r
182 \r
183 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
184 \r
185 <A NAME="constructor_detail"><!-- --></A>
186 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
187 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
188 <TD COLSPAN=1><FONT SIZE="+2">\r
189 <B>Constructor Detail</B></FONT></TD>\r
190 </TR>\r
191 </TABLE>\r
192 \r
193 <A NAME="WaveUtils()"><!-- --></A><H3>\r
194 WaveUtils</H3>\r
195 <PRE>\r
196 public <B>WaveUtils</B>()</PRE>\r
197 <DL>\r
198 </DL>\r
199 \r
200 <!-- ============ METHOD DETAIL ========== -->\r
201 \r
202 <A NAME="method_detail"><!-- --></A>
203 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
204 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
205 <TD COLSPAN=1><FONT SIZE="+2">\r
206 <B>Method Detail</B></FONT></TD>\r
207 </TR>\r
208 </TABLE>\r
209 \r
210 <A NAME="shortToUlaw(short)"><!-- --></A><H3>\r
211 shortToUlaw</H3>\r
212 <PRE>\r
213 public static final byte <B>shortToUlaw</B>(short&nbsp;sampleData)</PRE>\r
214 <DL>\r
215 <DD>Converts a raw short to ulaw.\r
216 <P>\r
217 <DD><DL>\r
218 <DT><B>Parameters:</B><DD><CODE>sampleData</CODE> - signed 16-bit linear sample
219 <DT><B>Returns:</B><DD>8-bit ulaw sample, normalized</DL>\r
220 </DD>\r
221 </DL>\r
222 <HR>\r
223 \r
224 <A NAME="ulawToShort(short)"><!-- --></A><H3>\r
225 ulawToShort</H3>\r
226 <PRE>\r
227 public static final short <B>ulawToShort</B>(short&nbsp;uByte)</PRE>\r
228 <DL>\r
229 <DD>Converts from ulaw to 16 bit linear.
230  <p>
231  Craig Reese: IDA/Supercomputing Research Center
232  <br>
233  29 September 1989
234  <p>
235  References:
236  <br>
237  1) CCITT Recommendation G.711  (very difficult to follow)
238  <br>
239  2) MIL-STD-188-113,"Interoperability and Performance Standards
240     for Analog-to_Digital Conversion Techniques," 17 February 1987\r
241 <P>\r
242 <DD><DL>\r
243 <DT><B>Parameters:</B><DD><CODE>uByte</CODE> - 8 bit ulaw sample
244 <DT><B>Returns:</B><DD>signed 16 bit linear sample</DL>\r
245 </DD>\r
246 </DL>\r
247 <HR>\r
248 \r
249 <A NAME="bytesToShort(byte, byte)"><!-- --></A><H3>\r
250 bytesToShort</H3>\r
251 <PRE>\r
252 public static final short <B>bytesToShort</B>(byte&nbsp;hiByte,
253                                        byte&nbsp;loByte)</PRE>\r
254 <DL>\r
255 <DD>Reconstructs a short from its hi and low bytes.\r
256 <P>\r
257 <DD><DL>\r
258 <DT><B>Parameters:</B><DD><CODE>hiByte</CODE> - the high byte<DD><CODE>loByte</CODE> - the low byte
259 <DT><B>Returns:</B><DD>the short value</DL>\r
260 </DD>\r
261 </DL>\r
262 <HR>\r
263 \r
264 <A NAME="main(java.lang.String[])"><!-- --></A><H3>\r
265 main</H3>\r
266 <PRE>\r
267 public static void <B>main</B>(java.lang.String[]&nbsp;args)</PRE>\r
268 <DL>\r
269 <DD>Provides test program for method ulawToShort().\r
270 <P>\r
271 <DD><DL>\r
272 <DT><B>Parameters:</B><DD><CODE>args</CODE> - not used</DL>\r
273 </DD>\r
274 </DL>\r
275 <!-- ========= END OF CLASS DATA ========= -->\r
276 <HR>\r
277 \r
278
279 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
280 <A NAME="navbar_bottom"><!-- --></A>
281 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
282 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
283 <TR>\r
284 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
285 <A NAME="navbar_bottom_firstrow"><!-- --></A>
286 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
287   <TR ALIGN="center" VALIGN="top">\r
288   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
289   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
290   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
291   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
292   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
293   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
294   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
295   </TR>\r
296 </TABLE>\r
297 </TD>\r
298 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
299 </EM>\r
300 </TD>\r
301 </TR>\r
302 \r
303 <TR>\r
304 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
305 &nbsp;<A HREF="../../../../../com/sun/speech/freetts/util/Utilities.html" title="class in com.sun.speech.freetts.util"><B>PREV CLASS</B></A>&nbsp;\r
306 &nbsp;NEXT CLASS</FONT></TD>\r
307 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
308   <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
309 &nbsp;<A HREF="WaveUtils.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
310 &nbsp;<SCRIPT type="text/javascript">\r
311   <!--\r
312   if(window==top) {\r
313     document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
314   }\r
315   //-->\r
316 </SCRIPT>\r
317 <NOSCRIPT>\r
318   <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>\r
319 </NOSCRIPT>
320 \r
321 </FONT></TD>\r
322 </TR>\r
323 <TR>\r
324 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
325   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
326 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
327 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
328 </TR>\r
329 </TABLE>\r
330 <A NAME="skip-navbar_bottom"></A>
331 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
332 \r
333 <HR>\r
334 \r
335 </BODY>\r
336 </HTML>\r