root/doc/html/classitpp_1_1SND__In__File.html @ 353

Revision 353, 17.5 kB (checked in by smidl, 16 years ago)

doc

Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3<title>mixpp: itpp::SND_In_File Class Reference</title>
4<link href="tabs.css" rel="stylesheet" type="text/css">
5<link href="doxygen.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.5.8 -->
8<script type="text/javascript">
9<!--
10function changeDisplayState (e){
11  var num=this.id.replace(/[^[0-9]/g,'');
12  var button=this.firstChild;
13  var sectionDiv=document.getElementById('dynsection'+num);
14  if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
15    sectionDiv.style.display='block';
16    button.src='open.gif';
17  }else{
18    sectionDiv.style.display='none';
19    button.src='closed.gif';
20  }
21}
22function initDynSections(){
23  var divs=document.getElementsByTagName('div');
24  var sectionCounter=1;
25  for(var i=0;i<divs.length-1;i++){
26    if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
27      var header=divs[i];
28      var section=divs[i+1];
29      var button=header.firstChild;
30      if (button!='IMG'){
31        divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
32        button=document.createElement('img');
33        divs[i].insertBefore(button,divs[i].firstChild);
34      }
35      header.style.cursor='pointer';
36      header.onclick=changeDisplayState;
37      header.id='dynheader'+sectionCounter;
38      button.src='closed.gif';
39      section.id='dynsection'+sectionCounter;
40      section.style.display='none';
41      section.style.marginLeft='14px';
42      sectionCounter++;
43    }
44  }
45}
46window.onload = initDynSections;
47-->
48</script>
49<div class="navigation" id="top">
50  <div class="tabs">
51    <ul>
52      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
53      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
54      <li><a href="modules.html"><span>Modules</span></a></li>
55      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
56      <li><a href="files.html"><span>Files</span></a></li>
57    </ul>
58  </div>
59  <div class="tabs">
60    <ul>
61      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
62      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
63      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
64      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
65    </ul>
66  </div>
67  <div class="navpath"><b>itpp</b>::<a class="el" href="classitpp_1_1SND__In__File.html">SND_In_File</a>
68  </div>
69</div>
70<div class="contents">
71<h1>itpp::SND_In_File Class Reference<br>
72<small>
73[<a class="el" href="group__audio.html">Audio</a>]</small>
74</h1><!-- doxytag: class="itpp::SND_In_File" --><!-- doxytag: inherits="itpp::Audio_File,itpp::SND_Format" -->A class to read SND-files (the .au format)<p>
75ACTION: ADD DETAILED DOCUMENTATION FOR THIS CLASS!!!!!!!!!!! 
76<a href="#_details">More...</a>
77<p>
78<code>#include &lt;<a class="el" href="audiofile_8h-source.html">audiofile.h</a>&gt;</code>
79<p>
80
81<p>
82<a href="classitpp_1_1SND__In__File-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
83<tr><td></td></tr>
84<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
85<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1SND__Format.html#26f6ebb3d6d736cec02b55df443b16df">data_encoding</a> { <br>
86&nbsp;&nbsp;<b>enc_unknown</b> =  0,
87<b>enc_mulaw8</b> =  1,
88<b>enc_alaw8</b> =  27,
89<b>enc_linear8</b> =  2,
90<br>
91&nbsp;&nbsp;<b>enc_linear16</b> =  3,
92<b>enc_linear24</b> =  4,
93<b>enc_linear32</b> =  5,
94<b>enc_float</b> =  6,
95<br>
96&nbsp;&nbsp;<b>enc_double</b> =  7
97<br>
98 }</td></tr>
99
100<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">ACTION: ADD DOCUMENTATION FOR THIS MEMBER!!!!!!!!!!! <br></td></tr>
101<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
102<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0e6b773619342b380d5587f6503b6371"></a><!-- doxytag: member="itpp::SND_In_File::SND_In_File" ref="0e6b773619342b380d5587f6503b6371" args="()" -->
103&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1SND__In__File.html#0e6b773619342b380d5587f6503b6371">SND_In_File</a> ()</td></tr>
104
105<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr>
106<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="577ed28e569f2c73e6687ee2d025c178"></a><!-- doxytag: member="itpp::SND_In_File::SND_In_File" ref="577ed28e569f2c73e6687ee2d025c178" args="(const char *fname)" -->
107&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1SND__In__File.html#577ed28e569f2c73e6687ee2d025c178">SND_In_File</a> (const char *fname)</td></tr>
108
109<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Open the file {<em>fname}</em>. <br></td></tr>
110<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d980abd7404fdd30de3ed21d0113d02f"></a><!-- doxytag: member="itpp::SND_In_File::~SND_In_File" ref="d980abd7404fdd30de3ed21d0113d02f" args="()" -->
111virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1SND__In__File.html#d980abd7404fdd30de3ed21d0113d02f">~SND_In_File</a> ()</td></tr>
112
113<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <br></td></tr>
114<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f525187eee417b854f2dee70d42760f5"></a><!-- doxytag: member="itpp::SND_In_File::open" ref="f525187eee417b854f2dee70d42760f5" args="(const char *fname)" -->
115virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1SND__In__File.html#f525187eee417b854f2dee70d42760f5">open</a> (const char *fname)</td></tr>
116
117<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Open the file {<em>fname}</em>. <br></td></tr>
118<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="840edfe6e6f3e3cf952667d783477f1f"></a><!-- doxytag: member="itpp::SND_In_File::close" ref="840edfe6e6f3e3cf952667d783477f1f" args="()" -->
119virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1SND__In__File.html#840edfe6e6f3e3cf952667d783477f1f">close</a> ()</td></tr>
120
121<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Close the file. <br></td></tr>
122<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0ff4bb6ee63f96695d1363b3ba28d7ba"></a><!-- doxytag: member="itpp::SND_In_File::seek_read" ref="0ff4bb6ee63f96695d1363b3ba28d7ba" args="(int pos)" -->
123bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1SND__In__File.html#0ff4bb6ee63f96695d1363b3ba28d7ba">seek_read</a> (int pos)</td></tr>
124
125<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Go to sample number {<em>pos}</em>. <br></td></tr>
126<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ccb5e454bd7ee7c41b2ea1d4a5876c6a"></a><!-- doxytag: member="itpp::SND_In_File::tell_read" ref="ccb5e454bd7ee7c41b2ea1d4a5876c6a" args="()" -->
127int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1SND__In__File.html#ccb5e454bd7ee7c41b2ea1d4a5876c6a">tell_read</a> ()</td></tr>
128
129<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the current sample position in the file. <br></td></tr>
130<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6e6aa3055020f95eb34aaf0d65cc5c99"></a><!-- doxytag: member="itpp::SND_In_File::read" ref="6e6aa3055020f95eb34aaf0d65cc5c99" args="(vec &amp;v)" -->
131virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1SND__In__File.html#6e6aa3055020f95eb34aaf0d65cc5c99">read</a> (vec &amp;v)</td></tr>
132
133<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read the whole file into the vector {<em>v}</em>. <br></td></tr>
134<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d8c3566b6e11938ba0ba39d4333499b7"></a><!-- doxytag: member="itpp::SND_In_File::read" ref="d8c3566b6e11938ba0ba39d4333499b7" args="(vec &amp;v, int n)" -->
135virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1SND__In__File.html#d8c3566b6e11938ba0ba39d4333499b7">read</a> (vec &amp;v, int n)</td></tr>
136
137<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read {<em>n}</em> samples into the vector {<em>v}</em>. <br></td></tr>
138<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="88a601ad1fbfa37d3efb15d27b92b2cf"></a><!-- doxytag: member="itpp::SND_In_File::good" ref="88a601ad1fbfa37d3efb15d27b92b2cf" args="()" -->
139bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Audio__File.html#88a601ad1fbfa37d3efb15d27b92b2cf">good</a> ()</td></tr>
140
141<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns true if everything is OK. <br></td></tr>
142<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4844d5f06f5b141e64c9f54a39a6fae8"></a><!-- doxytag: member="itpp::SND_In_File::encoding" ref="4844d5f06f5b141e64c9f54a39a6fae8" args="() const " -->
143<a class="el" href="classitpp_1_1SND__Format.html#26f6ebb3d6d736cec02b55df443b16df">data_encoding</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1SND__Format.html#4844d5f06f5b141e64c9f54a39a6fae8">encoding</a> () const </td></tr>
144
145<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">ACTION: ADD DOCUMENTATION FOR THIS MEMBER!!!!!!!!!!! <br></td></tr>
146<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ea74000acc65757ec6492da0261592bd"></a><!-- doxytag: member="itpp::SND_In_File::channels" ref="ea74000acc65757ec6492da0261592bd" args="() const " -->
147int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1SND__Format.html#ea74000acc65757ec6492da0261592bd">channels</a> () const </td></tr>
148
149<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">ACTION: ADD DOCUMENTATION FOR THIS MEMBER!!!!!!!!!!! <br></td></tr>
150<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ce7fb71e1fb6a6b919c63341e349bea6"></a><!-- doxytag: member="itpp::SND_In_File::samples" ref="ce7fb71e1fb6a6b919c63341e349bea6" args="() const " -->
151int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1SND__Format.html#ce7fb71e1fb6a6b919c63341e349bea6">samples</a> () const </td></tr>
152
153<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">ACTION: ADD DOCUMENTATION FOR THIS MEMBER!!!!!!!!!!! <br></td></tr>
154<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2d9783d4bfcba85693d8ec63099978cc"></a><!-- doxytag: member="itpp::SND_In_File::rate" ref="2d9783d4bfcba85693d8ec63099978cc" args="() const " -->
155int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1SND__Format.html#2d9783d4bfcba85693d8ec63099978cc">rate</a> () const </td></tr>
156
157<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">ACTION: ADD DOCUMENTATION FOR THIS MEMBER!!!!!!!!!!! <br></td></tr>
158<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="62b1a80812b6a7dd3053c2ee4f30f388"></a><!-- doxytag: member="itpp::SND_In_File::set_rate" ref="62b1a80812b6a7dd3053c2ee4f30f388" args="(int r)" -->
159void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1SND__Format.html#62b1a80812b6a7dd3053c2ee4f30f388">set_rate</a> (int r)</td></tr>
160
161<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">ACTION: ADD DOCUMENTATION FOR THIS MEMBER!!!!!!!!!!! <br></td></tr>
162<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
163<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a4d9f7998fb34d064cd2299a51659a19"></a><!-- doxytag: member="itpp::SND_In_File::sample_size" ref="a4d9f7998fb34d064cd2299a51659a19" args="() const " -->
164int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1SND__Format.html#a4d9f7998fb34d064cd2299a51659a19">sample_size</a> () const </td></tr>
165
166<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">ACTION: Add documentation for this protected member. <br></td></tr>
167<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a8129c4a0eeacc3a5771cf4493e12812"></a><!-- doxytag: member="itpp::SND_In_File::read_header" ref="a8129c4a0eeacc3a5771cf4493e12812" args="(std::istream &amp;f)" -->
168bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1SND__Format.html#a8129c4a0eeacc3a5771cf4493e12812">read_header</a> (std::istream &amp;f)</td></tr>
169
170<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">ACTION: Add documentation for this protected member. <br></td></tr>
171<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0bdd4f9d87e35c848bc120b23ab8792b"></a><!-- doxytag: member="itpp::SND_In_File::write_header" ref="0bdd4f9d87e35c848bc120b23ab8792b" args="(std::ostream &amp;f)" -->
172bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1SND__Format.html#0bdd4f9d87e35c848bc120b23ab8792b">write_header</a> (std::ostream &amp;f)</td></tr>
173
174<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">ACTION: Add documentation for this protected member. <br></td></tr>
175<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
176<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d00897ead593c9026b9bd6bc9d950ea4"></a><!-- doxytag: member="itpp::SND_In_File::file" ref="d00897ead593c9026b9bd6bc9d950ea4" args="" -->
177std::fstream&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Audio__File.html#d00897ead593c9026b9bd6bc9d950ea4">file</a></td></tr>
178
179<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">ACTION: Add documentation for this protected member. <br></td></tr>
180<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="37b9ea39b8ba906ea699ca6de11ab9b5"></a><!-- doxytag: member="itpp::SND_In_File::is_valid" ref="37b9ea39b8ba906ea699ca6de11ab9b5" args="" -->
181bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Audio__File.html#37b9ea39b8ba906ea699ca6de11ab9b5">is_valid</a></td></tr>
182
183<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">ACTION: Add documentation for this protected member. <br></td></tr>
184<tr><td class="memItemLeft" nowrap><a class="anchor" name="c79ae4fa23a6abf0dd65f73641d4659c"></a><!-- doxytag: member="itpp::SND_In_File::header" ref="c79ae4fa23a6abf0dd65f73641d4659c" args="" -->
185struct {</td></tr>
186
187<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;unsigned&nbsp;&nbsp;&nbsp;<a class="el" href="classitpp_1_1SND__Format.html#1ebe6b8b09cdf2fbb2afeaf67f66b85a">magic</a></td></tr>
188
189<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Magic number. <br></td></tr>
190<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;unsigned&nbsp;&nbsp;&nbsp;<a class="el" href="classitpp_1_1SND__Format.html#dc1bd25e8233d147e46ba923a1f08602">hdr_size</a></td></tr>
191
192<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Size of this header. <br></td></tr>
193<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;unsigned&nbsp;&nbsp;&nbsp;<a class="el" href="classitpp_1_1SND__Format.html#3fcda8c137af97cff21c29170993dbf4">data_size</a></td></tr>
194
195<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Length of data (optional). <br></td></tr>
196<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;unsigned&nbsp;&nbsp;&nbsp;<a class="el" href="classitpp_1_1SND__Format.html#7f1b2106344ae9943bcb1d6a36040d3a">encoding</a></td></tr>
197
198<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Data encoding format. <br></td></tr>
199<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;unsigned&nbsp;&nbsp;&nbsp;<a class="el" href="classitpp_1_1SND__Format.html#9cddb513c7799ca652ed7bef58482511">sample_rate</a></td></tr>
200
201<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Samples per second. <br></td></tr>
202<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;unsigned&nbsp;&nbsp;&nbsp;<a class="el" href="classitpp_1_1SND__Format.html#03305ae2cf885ed07759af2e2b999df9">channels</a></td></tr>
203
204<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Number of interleaved channels. <br></td></tr>
205<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;char&nbsp;&nbsp;&nbsp;<a class="el" href="classitpp_1_1SND__Format.html#d9de8b700ba5029df5e6e5f652b4fec5">info</a> [SND_INFO_LEN]</td></tr>
206
207<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Info string. <br></td></tr>
208<tr><td class="memItemLeft" nowrap valign="top">}&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1SND__Format.html#c79ae4fa23a6abf0dd65f73641d4659c">header</a></td></tr>
209
210<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Definition of the header structure. <br></td></tr>
211</table>
212<hr><a name="_details"></a><h2>Detailed Description</h2>
213A class to read SND-files (the .au format)<p>
214ACTION: ADD DETAILED DOCUMENTATION FOR THIS CLASS!!!!!!!!!!! <hr>The documentation for this class was generated from the following file:<ul>
215<li><a class="el" href="audiofile_8h-source.html">audiofile.h</a></ul>
216</div>
217<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:02:19 2009 for mixpp by&nbsp;
218<a href="http://www.doxygen.org/index.html">
219<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
220</body>
221</html>
Note: See TracBrowser for help on using the browser.