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 SampleSet (FreeTTS 1.2)
\r
10 <META NAME="keywords" CONTENT="com.sun.speech.freetts.relp.SampleSet 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="SampleSet (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/SampleInfo.html" title="class in com.sun.speech.freetts.relp"><B>PREV CLASS</B></A>
\r
53 <A HREF="../../../../../com/sun/speech/freetts/relp/UnitConcatenator.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="SampleSet.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 | FIELD | <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: FIELD | <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 SampleSet</H2>
\r
89 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>com.sun.speech.freetts.relp.SampleSet</B>
\r
93 <DT>public class <B>SampleSet</B><DT>extends java.lang.Object</DL>
\r
96 Represents the frame and residual data
97 used by the diphone database
98 used Residual Excited Linear Predictive synthesizer
\r
105 <!-- ======== NESTED CLASS SUMMARY ======== -->
\r
108 <!-- =========== FIELD SUMMARY =========== -->
\r
111 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
\r
113 <A NAME="constructor_summary"><!-- --></A>
114 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
115 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
116 <TD COLSPAN=2><FONT SIZE="+2">
\r
117 <B>Constructor Summary</B></FONT></TD>
\r
119 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
120 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/relp/SampleSet.html#SampleSet(java.nio.ByteBuffer)">SampleSet</A></B>(java.nio.ByteBuffer bb)</CODE>
\r
123 Creates a SampleSet by reading it from the given byte buffer</TD>
\r
125 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
126 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/relp/SampleSet.html#SampleSet(java.io.DataInputStream)">SampleSet</A></B>(java.io.DataInputStream is)</CODE>
\r
129 Creates a SampleSet by reading it from the given input stream</TD>
\r
131 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
132 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/relp/SampleSet.html#SampleSet(java.util.StringTokenizer, java.io.BufferedReader)">SampleSet</A></B>(java.util.StringTokenizer tok,
133 java.io.BufferedReader reader)</CODE>
\r
136 Reads a SampleSet from the input reader.</TD>
\r
140 <!-- ========== METHOD SUMMARY =========== -->
\r
142 <A NAME="method_summary"><!-- --></A>
143 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
144 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
145 <TD COLSPAN=2><FONT SIZE="+2">
\r
146 <B>Method Summary</B></FONT></TD>
\r
148 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
149 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
150 <CODE> void</CODE></FONT></TD>
\r
151 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/relp/SampleSet.html#dumpBinary(java.io.DataOutputStream)">dumpBinary</A></B>(java.io.DataOutputStream os)</CODE>
\r
154 Dumps this sample set to the given stream</TD>
\r
156 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
157 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
158 <CODE> int</CODE></FONT></TD>
\r
159 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/relp/SampleSet.html#getFrameSize(int)">getFrameSize</A></B>(int frame)</CODE>
\r
162 Gets the size of the given frame</TD>
\r
164 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
165 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
166 <CODE> <A HREF="../../../../../com/sun/speech/freetts/relp/Sample.html" title="class in com.sun.speech.freetts.relp">Sample</A></CODE></FONT></TD>
\r
167 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/relp/SampleSet.html#getSample(int)">getSample</A></B>(int index)</CODE>
\r
170 return the sample associated with the index</TD>
\r
172 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
173 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
174 <CODE> <A HREF="../../../../../com/sun/speech/freetts/relp/SampleInfo.html" title="class in com.sun.speech.freetts.relp">SampleInfo</A></CODE></FONT></TD>
\r
175 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/relp/SampleSet.html#getSampleInfo()">getSampleInfo</A></B>()</CODE>
\r
178 Retrieves the info on this SampleSet</TD>
\r
180 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
181 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
182 <CODE> int</CODE></FONT></TD>
\r
183 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/relp/SampleSet.html#getUnitSize(int, int)">getUnitSize</A></B>(int start,
184 int end)</CODE>
\r
187 Returns the size of the unit represented
188 by the given start and end points</TD>
\r
191 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
192 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
193 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
194 <TD><B>Methods inherited from class java.lang.Object</B></TD>
\r
196 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
197 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
\r
203 <!-- ============ FIELD DETAIL =========== -->
\r
206 <!-- ========= CONSTRUCTOR DETAIL ======== -->
\r
208 <A NAME="constructor_detail"><!-- --></A>
209 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
210 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
211 <TD COLSPAN=1><FONT SIZE="+2">
\r
212 <B>Constructor Detail</B></FONT></TD>
\r
216 <A NAME="SampleSet(java.util.StringTokenizer, java.io.BufferedReader)"><!-- --></A><H3>
\r
219 public <B>SampleSet</B>(java.util.StringTokenizer tok,
220 java.io.BufferedReader reader)</PRE>
\r
222 <DD>Reads a SampleSet from the input reader.
\r
224 <DT><B>Parameters:</B><DD><CODE>tok</CODE> - tokenizer that holds parameters for this SampleSet<DD><CODE>reader</CODE> - the input reader to read the data from</DL>
\r
227 <A NAME="SampleSet(java.nio.ByteBuffer)"><!-- --></A><H3>
\r
230 public <B>SampleSet</B>(java.nio.ByteBuffer bb)
231 throws java.io.IOException</PRE>
\r
233 <DD>Creates a SampleSet by reading it from the given byte buffer
\r
235 <DT><B>Parameters:</B><DD><CODE>bb</CODE> - source of the Unit data
237 <DD><CODE>java.io.IOException</CODE> - if an IO error occurs</DL>
\r
240 <A NAME="SampleSet(java.io.DataInputStream)"><!-- --></A><H3>
\r
243 public <B>SampleSet</B>(java.io.DataInputStream is)
244 throws java.io.IOException</PRE>
\r
246 <DD>Creates a SampleSet by reading it from the given input stream
\r
248 <DT><B>Parameters:</B><DD><CODE>is</CODE> - source of the Unit data
250 <DD><CODE>java.io.IOException</CODE> - if an IO error occurs</DL>
\r
252 <!-- ============ METHOD DETAIL ========== -->
\r
254 <A NAME="method_detail"><!-- --></A>
255 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
256 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
257 <TD COLSPAN=1><FONT SIZE="+2">
\r
258 <B>Method Detail</B></FONT></TD>
\r
262 <A NAME="dumpBinary(java.io.DataOutputStream)"><!-- --></A><H3>
\r
265 public void <B>dumpBinary</B>(java.io.DataOutputStream os)
266 throws java.io.IOException</PRE>
\r
268 <DD>Dumps this sample set to the given stream
\r
271 <DT><B>Parameters:</B><DD><CODE>os</CODE> - the output stream
273 <DD><CODE>java.io.IOException</CODE> - if an error occurs.</DL>
\r
278 <A NAME="getSample(int)"><!-- --></A><H3>
\r
281 public <A HREF="../../../../../com/sun/speech/freetts/relp/Sample.html" title="class in com.sun.speech.freetts.relp">Sample</A> <B>getSample</B>(int index)</PRE>
\r
283 <DD>return the sample associated with the index
\r
286 <DT><B>Parameters:</B><DD><CODE>index</CODE> - the index of the sample
287 <DT><B>Returns:</B><DD>the sample.</DL>
\r
292 <A NAME="getSampleInfo()"><!-- --></A><H3>
\r
295 public <A HREF="../../../../../com/sun/speech/freetts/relp/SampleInfo.html" title="class in com.sun.speech.freetts.relp">SampleInfo</A> <B>getSampleInfo</B>()</PRE>
\r
297 <DD>Retrieves the info on this SampleSet
\r
301 <DT><B>Returns:</B><DD>the sample info</DL>
\r
306 <A NAME="getUnitSize(int, int)"><!-- --></A><H3>
\r
309 public int <B>getUnitSize</B>(int start,
310 int end)</PRE>
\r
312 <DD>Returns the size of the unit represented
313 by the given start and end points
\r
316 <DT><B>Parameters:</B><DD><CODE>start</CODE> - the start of the unit<DD><CODE>end</CODE> - the end of the unit
317 <DT><B>Returns:</B><DD>the size of the unit</DL>
\r
322 <A NAME="getFrameSize(int)"><!-- --></A><H3>
\r
325 public int <B>getFrameSize</B>(int frame)</PRE>
\r
327 <DD>Gets the size of the given frame
\r
330 <DT><B>Parameters:</B><DD><CODE>frame</CODE> - the frame of interest
331 <DT><B>Returns:</B><DD>the size of the frame</DL>
\r
334 <!-- ========= END OF CLASS DATA ========= -->
\r
338 <!-- ======= START OF BOTTOM NAVBAR ====== -->
\r
339 <A NAME="navbar_bottom"><!-- --></A>
340 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
341 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
\r
343 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
\r
344 <A NAME="navbar_bottom_firstrow"><!-- --></A>
345 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
\r
346 <TR ALIGN="center" VALIGN="top">
\r
347 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
\r
348 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
349 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
350 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
351 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
352 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
353 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
357 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
363 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
364 <A HREF="../../../../../com/sun/speech/freetts/relp/SampleInfo.html" title="class in com.sun.speech.freetts.relp"><B>PREV CLASS</B></A>
\r
365 <A HREF="../../../../../com/sun/speech/freetts/relp/UnitConcatenator.html" title="class in com.sun.speech.freetts.relp"><B>NEXT CLASS</B></A></FONT></TD>
\r
366 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
367 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
\r
368 <A HREF="SampleSet.html" target="_top"><B>NO FRAMES</B></A>
\r
369 <SCRIPT type="text/javascript">
\r
372 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
377 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
383 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
384 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
385 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
386 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
389 <A NAME="skip-navbar_bottom"></A>
390 <!-- ======== END OF BOTTOM NAVBAR ======= -->
\r