1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
\r
5 <!-- Generated by javadoc (build 1.4.2_16) on Mon Mar 09 18:20:30 CET 2009 -->
\r
7 SampleInfo (FreeTTS 1.2)
\r
10 <META NAME="keywords" CONTENT="com.sun.speech.freetts.relp.SampleInfo class">
\r
12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
\r
14 <SCRIPT type="text/javascript">
\r
15 function windowTitle()
\r
17 parent.document.title="SampleInfo (FreeTTS 1.2)";
\r
23 <BODY BGCOLOR="white" onload="windowTitle();">
\r
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
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> </TD>
\r
36 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
37 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
45 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
51 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
52 <A HREF="../../../../../com/sun/speech/freetts/relp/Sample.html" title="class in com.sun.speech.freetts.relp"><B>PREV CLASS</B></A>
\r
53 <A HREF="../../../../../com/sun/speech/freetts/relp/SampleSet.html" title="class in com.sun.speech.freetts.relp"><B>NEXT CLASS</B></A></FONT></TD>
\r
54 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
55 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
\r
56 <A HREF="SampleInfo.html" target="_top"><B>NO FRAMES</B></A>
\r
57 <SCRIPT type="text/javascript">
\r
60 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
65 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
71 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
72 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
73 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
74 DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
77 <A NAME="skip-navbar_top"></A>
78 <!-- ========= END OF TOP NAVBAR ========= -->
\r
81 <!-- ======== START OF CLASS DATA ======== -->
\r
84 com.sun.speech.freetts.relp</FONT>
\r
86 Class SampleInfo</H2>
\r
89 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>com.sun.speech.freetts.relp.SampleInfo</B>
\r
93 <DT>public class <B>SampleInfo</B><DT>extends java.lang.Object</DL>
\r
96 Describes global sample parameters. A sample info is generally added
97 to an utterance to describe the type of unit data that has been
105 <!-- ======== NESTED CLASS SUMMARY ======== -->
\r
108 <!-- =========== FIELD SUMMARY =========== -->
\r
110 <A NAME="field_summary"><!-- --></A>
111 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
112 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
113 <TD COLSPAN=2><FONT SIZE="+2">
\r
114 <B>Field Summary</B></FONT></TD>
\r
116 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
117 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
118 <CODE>static java.lang.String</CODE></FONT></TD>
\r
119 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/relp/SampleInfo.html#UTT_NAME">UTT_NAME</A></B></CODE>
\r
122 </TD>
\r
126 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
\r
128 <A NAME="constructor_summary"><!-- --></A>
129 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
130 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
131 <TD COLSPAN=2><FONT SIZE="+2">
\r
132 <B>Constructor Summary</B></FONT></TD>
\r
134 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
135 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/relp/SampleInfo.html#SampleInfo(java.nio.ByteBuffer)">SampleInfo</A></B>(java.nio.ByteBuffer bb)</CODE>
\r
138 Constructs a sample info from the given byte buffer.</TD>
\r
140 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
141 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/relp/SampleInfo.html#SampleInfo(java.io.DataInputStream)">SampleInfo</A></B>(java.io.DataInputStream is)</CODE>
\r
144 Constructs a sample info from the given input stream</TD>
\r
146 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
147 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/relp/SampleInfo.html#SampleInfo(int, int, int, float, float, float)">SampleInfo</A></B>(int sampleRate,
148 int numberOfChannels,
149 int residualFold,
151 float coeffRange,
152 float postEmphasis)</CODE>
\r
155 Creates a new sample info.</TD>
\r
159 <!-- ========== METHOD SUMMARY =========== -->
\r
161 <A NAME="method_summary"><!-- --></A>
162 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
163 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
164 <TD COLSPAN=2><FONT SIZE="+2">
\r
165 <B>Method Summary</B></FONT></TD>
\r
167 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
168 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
169 <CODE> void</CODE></FONT></TD>
\r
170 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/relp/SampleInfo.html#dumpBinary(java.io.DataOutputStream)">dumpBinary</A></B>(java.io.DataOutputStream os)</CODE>
\r
173 Dump a binary form of the sample rate
174 to the given output stream</TD>
\r
176 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
177 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
178 <CODE> float</CODE></FONT></TD>
\r
179 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/relp/SampleInfo.html#getCoeffMin()">getCoeffMin</A></B>()</CODE>
\r
182 Returns the minimum for linear predictive coding.</TD>
\r
184 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
185 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
186 <CODE> float</CODE></FONT></TD>
\r
187 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/relp/SampleInfo.html#getCoeffRange()">getCoeffRange</A></B>()</CODE>
\r
190 Returns the range for linear predictive coding.</TD>
\r
192 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
193 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
194 <CODE> int</CODE></FONT></TD>
\r
195 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/relp/SampleInfo.html#getNumberOfChannels()">getNumberOfChannels</A></B>()</CODE>
\r
198 Returns the number of channels.</TD>
\r
200 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
201 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
202 <CODE> float</CODE></FONT></TD>
\r
203 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/relp/SampleInfo.html#getPostEmphasis()">getPostEmphasis</A></B>()</CODE>
\r
206 Returns the post emphasis</TD>
\r
208 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
209 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
210 <CODE> int</CODE></FONT></TD>
\r
211 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/relp/SampleInfo.html#getResidualFold()">getResidualFold</A></B>()</CODE>
\r
214 Returns the residual fold.</TD>
\r
216 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
217 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
218 <CODE> int</CODE></FONT></TD>
\r
219 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/relp/SampleInfo.html#getSampleRate()">getSampleRate</A></B>()</CODE>
\r
222 Returns the sample rate.</TD>
\r
225 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
226 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
227 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
228 <TD><B>Methods inherited from class java.lang.Object</B></TD>
\r
230 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
231 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
\r
237 <!-- ============ FIELD DETAIL =========== -->
\r
239 <A NAME="field_detail"><!-- --></A>
240 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
241 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
242 <TD COLSPAN=1><FONT SIZE="+2">
\r
243 <B>Field Detail</B></FONT></TD>
\r
247 <A NAME="UTT_NAME"><!-- --></A><H3>
\r
250 public static final java.lang.String <B>UTT_NAME</B></PRE>
\r
253 <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sun.speech.freetts.relp.SampleInfo.UTT_NAME">Constant Field Values</A></DL>
\r
256 <!-- ========= CONSTRUCTOR DETAIL ======== -->
\r
258 <A NAME="constructor_detail"><!-- --></A>
259 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
260 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
261 <TD COLSPAN=1><FONT SIZE="+2">
\r
262 <B>Constructor Detail</B></FONT></TD>
\r
266 <A NAME="SampleInfo(int, int, int, float, float, float)"><!-- --></A><H3>
\r
269 public <B>SampleInfo</B>(int sampleRate,
270 int numberOfChannels,
271 int residualFold,
273 float coeffRange,
274 float postEmphasis)</PRE>
\r
276 <DD>Creates a new sample info.
\r
278 <DT><B>Parameters:</B><DD><CODE>sampleRate</CODE> - the sample rate<DD><CODE>numberOfChannels</CODE> - the number of channels<DD><CODE>residualFold</CODE> - the residual fold<DD><CODE>coeffMin</CODE> - the minimum coefficient<DD><CODE>coeffRange</CODE> - the range of coefficients</DL>
\r
281 <A NAME="SampleInfo(java.nio.ByteBuffer)"><!-- --></A><H3>
\r
284 public <B>SampleInfo</B>(java.nio.ByteBuffer bb)
285 throws java.io.IOException</PRE>
\r
287 <DD>Constructs a sample info from the given byte buffer.
\r
289 <DT><B>Parameters:</B><DD><CODE>bb</CODE> - the byte buffer
291 <DD><CODE>java.io.IOException</CODE> - if an input error occurs</DL>
\r
294 <A NAME="SampleInfo(java.io.DataInputStream)"><!-- --></A><H3>
\r
297 public <B>SampleInfo</B>(java.io.DataInputStream is)
298 throws java.io.IOException</PRE>
\r
300 <DD>Constructs a sample info from the given input stream
\r
302 <DT><B>Parameters:</B><DD><CODE>is</CODE> - the input stream
304 <DD><CODE>java.io.IOException</CODE> - if an input error occurs</DL>
\r
306 <!-- ============ METHOD DETAIL ========== -->
\r
308 <A NAME="method_detail"><!-- --></A>
309 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
310 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
311 <TD COLSPAN=1><FONT SIZE="+2">
\r
312 <B>Method Detail</B></FONT></TD>
\r
316 <A NAME="getSampleRate()"><!-- --></A><H3>
\r
319 public final int <B>getSampleRate</B>()</PRE>
\r
321 <DD>Returns the sample rate.
\r
325 <DT><B>Returns:</B><DD>the sample rate</DL>
\r
330 <A NAME="getNumberOfChannels()"><!-- --></A><H3>
\r
331 getNumberOfChannels</H3>
\r
333 public final int <B>getNumberOfChannels</B>()</PRE>
\r
335 <DD>Returns the number of channels.
\r
339 <DT><B>Returns:</B><DD>the number of channels.</DL>
\r
344 <A NAME="getResidualFold()"><!-- --></A><H3>
\r
345 getResidualFold</H3>
\r
347 public final int <B>getResidualFold</B>()</PRE>
\r
349 <DD>Returns the residual fold.
\r
353 <DT><B>Returns:</B><DD>the residual fold</DL>
\r
358 <A NAME="getCoeffMin()"><!-- --></A><H3>
\r
361 public final float <B>getCoeffMin</B>()</PRE>
\r
363 <DD>Returns the minimum for linear predictive coding.
\r
367 <DT><B>Returns:</B><DD>the minimum for linear predictive coding.</DL>
\r
372 <A NAME="getCoeffRange()"><!-- --></A><H3>
\r
375 public final float <B>getCoeffRange</B>()</PRE>
\r
377 <DD>Returns the range for linear predictive coding.
\r
381 <DT><B>Returns:</B><DD>the range for linear predictive coding.</DL>
\r
386 <A NAME="getPostEmphasis()"><!-- --></A><H3>
\r
387 getPostEmphasis</H3>
\r
389 public final float <B>getPostEmphasis</B>()</PRE>
\r
391 <DD>Returns the post emphasis
\r
395 <DT><B>Returns:</B><DD>the post emphasis</DL>
\r
400 <A NAME="dumpBinary(java.io.DataOutputStream)"><!-- --></A><H3>
\r
403 public void <B>dumpBinary</B>(java.io.DataOutputStream os)
404 throws java.io.IOException</PRE>
\r
406 <DD>Dump a binary form of the sample rate
407 to the given output stream
\r
410 <DT><B>Parameters:</B><DD><CODE>os</CODE> - the output stream
412 <DD><CODE>java.io.IOException</CODE> - if an error occurs</DL>
\r
415 <!-- ========= END OF CLASS DATA ========= -->
\r
419 <!-- ======= START OF BOTTOM NAVBAR ====== -->
\r
420 <A NAME="navbar_bottom"><!-- --></A>
421 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
422 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
\r
424 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
\r
425 <A NAME="navbar_bottom_firstrow"><!-- --></A>
426 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
\r
427 <TR ALIGN="center" VALIGN="top">
\r
428 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
\r
429 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
430 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
431 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
432 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
433 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
434 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
438 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
444 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
445 <A HREF="../../../../../com/sun/speech/freetts/relp/Sample.html" title="class in com.sun.speech.freetts.relp"><B>PREV CLASS</B></A>
\r
446 <A HREF="../../../../../com/sun/speech/freetts/relp/SampleSet.html" title="class in com.sun.speech.freetts.relp"><B>NEXT CLASS</B></A></FONT></TD>
\r
447 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
448 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
\r
449 <A HREF="SampleInfo.html" target="_top"><B>NO FRAMES</B></A>
\r
450 <SCRIPT type="text/javascript">
\r
453 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
458 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
464 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
465 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
466 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
467 DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
470 <A NAME="skip-navbar_bottom"></A>
471 <!-- ======== END OF BOTTOM NAVBAR ======= -->
\r