root/doc/html/audiofile_8h.html @ 353

Revision 353, 13.9 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: audiofile.h File 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><a href="annotated.html"><span>Classes</span></a></li>
56      <li class="current"><a href="files.html"><span>Files</span></a></li>
57    </ul>
58  </div>
59  <div class="tabs">
60    <ul>
61      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
62      <li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
63    </ul>
64  </div>
65</div>
66<div class="contents">
67<h1>audiofile.h File Reference</h1>Definitions of audio Audio classes and functions. 
68<a href="#_details">More...</a>
69<p>
70<code>#include &lt;<a class="el" href="vec_8h-source.html">itpp/base/vec.h</a>&gt;</code><br>
71<code>#include &lt;<a class="el" href="misc_8h-source.html">itpp/base/math/misc.h</a>&gt;</code><br>
72<code>#include &lt;fstream&gt;</code><br>
73
74<p>
75<a href="audiofile_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
76<tr><td></td></tr>
77<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
78<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Audio__File.html">itpp::Audio_File</a></td></tr>
79
80<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Base class - do not use this one!<p>
81ACTION: ADD DETAILED DOCUMENTATION FOR THIS CLASS!!!!!!!!!!!  <a href="classitpp_1_1Audio__File.html#_details">More...</a><br></td></tr>
82<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1SND__Format.html">itpp::SND_Format</a></td></tr>
83
84<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Base class for SND reading classes (the .au format)<p>
85ACTION: ADD DETAILED DOCUMENTATION FOR THIS CLASS!!!!!!!!!!!  <a href="classitpp_1_1SND__Format.html#_details">More...</a><br></td></tr>
86<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1SND__In__File.html">itpp::SND_In_File</a></td></tr>
87
88<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A class to read SND-files (the .au format)<p>
89ACTION: ADD DETAILED DOCUMENTATION FOR THIS CLASS!!!!!!!!!!!  <a href="classitpp_1_1SND__In__File.html#_details">More...</a><br></td></tr>
90<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1SND__Out__File.html">itpp::SND_Out_File</a></td></tr>
91
92<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A class to write SND-files (the .au format)<p>
93ACTION: ADD DETAILED DOCUMENTATION FOR THIS CLASS!!!!!!!!!!!  <a href="classitpp_1_1SND__Out__File.html#_details">More...</a><br></td></tr>
94<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1SND__IO__File.html">itpp::SND_IO_File</a></td></tr>
95
96<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This class is capable of doing both input and output.<p>
97ACTION: ADD DETAILED DOCUMENTATION FOR THIS CLASS!!!!!!!!!!!  <a href="classitpp_1_1SND__IO__File.html#_details">More...</a><br></td></tr>
98<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
99<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g33d77ea20ae9fd06562d6eb33c80774e"></a><!-- doxytag: member="audiofile.h::raw16le_read" ref="g33d77ea20ae9fd06562d6eb33c80774e" args="(const char *fname, vec &amp;v)" -->
100bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio.html#g33d77ea20ae9fd06562d6eb33c80774e">itpp::raw16le_read</a> (const char *fname, <a class="el" href="classitpp_1_1Vec.html#02e1bb55f60f3c2eb7a020eb1c2cfcf4">vec</a> &amp;v)</td></tr>
101
102<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read raw 16-bin little endian audio data. <br></td></tr>
103<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g58eb7426fce079a561e88acad6391f11"></a><!-- doxytag: member="audiofile.h::raw16le_read" ref="g58eb7426fce079a561e88acad6391f11" args="(const char *fname, vec &amp;v, int beg, int len)" -->
104bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio.html#g58eb7426fce079a561e88acad6391f11">itpp::raw16le_read</a> (const char *fname, <a class="el" href="classitpp_1_1Vec.html#02e1bb55f60f3c2eb7a020eb1c2cfcf4">vec</a> &amp;v, int beg, int len)</td></tr>
105
106<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read raw 16-bin little endian audio data. <br></td></tr>
107<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g97a907aa18e37563e117079fdf535d14"></a><!-- doxytag: member="audiofile.h::raw16le_write" ref="g97a907aa18e37563e117079fdf535d14" args="(const char *fname, const vec &amp;v, bool append=false)" -->
108bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio.html#g97a907aa18e37563e117079fdf535d14">itpp::raw16le_write</a> (const char *fname, const <a class="el" href="classitpp_1_1Vec.html#02e1bb55f60f3c2eb7a020eb1c2cfcf4">vec</a> &amp;v, bool append=false)</td></tr>
109
110<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write raw 16-bin little endian audio data. <br></td></tr>
111<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gffa49e71b2c76cb54e16eaf34e97dde6"></a><!-- doxytag: member="audiofile.h::raw16be_read" ref="gffa49e71b2c76cb54e16eaf34e97dde6" args="(const char *fname, vec &amp;v)" -->
112bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio.html#gffa49e71b2c76cb54e16eaf34e97dde6">itpp::raw16be_read</a> (const char *fname, <a class="el" href="classitpp_1_1Vec.html#02e1bb55f60f3c2eb7a020eb1c2cfcf4">vec</a> &amp;v)</td></tr>
113
114<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read raw 16-bin big endian audio data. <br></td></tr>
115<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g26f487ede767855ba05a11b74bb0211e"></a><!-- doxytag: member="audiofile.h::raw16be_read" ref="g26f487ede767855ba05a11b74bb0211e" args="(const char *fname, vec &amp;v, int beg, int len)" -->
116bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio.html#g26f487ede767855ba05a11b74bb0211e">itpp::raw16be_read</a> (const char *fname, <a class="el" href="classitpp_1_1Vec.html#02e1bb55f60f3c2eb7a020eb1c2cfcf4">vec</a> &amp;v, int beg, int len)</td></tr>
117
118<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read raw 16-bin big endian audio data. <br></td></tr>
119<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g3995ddfbca5ef1b203388d640ca56e91"></a><!-- doxytag: member="audiofile.h::raw16be_write" ref="g3995ddfbca5ef1b203388d640ca56e91" args="(const char *fname, const vec &amp;v, bool append=false)" -->
120bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio.html#g3995ddfbca5ef1b203388d640ca56e91">itpp::raw16be_write</a> (const char *fname, const <a class="el" href="classitpp_1_1Vec.html#02e1bb55f60f3c2eb7a020eb1c2cfcf4">vec</a> &amp;v, bool append=false)</td></tr>
121
122<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write raw 16-bin big endian audio data. <br></td></tr>
123<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gbae2d4c033b2f91e043046232e43885e"></a><!-- doxytag: member="audiofile.h::snd_read" ref="gbae2d4c033b2f91e043046232e43885e" args="(const char *fname, vec &amp;v)" -->
124bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio.html#gbae2d4c033b2f91e043046232e43885e">itpp::snd_read</a> (const char *fname, <a class="el" href="classitpp_1_1Vec.html#02e1bb55f60f3c2eb7a020eb1c2cfcf4">vec</a> &amp;v)</td></tr>
125
126<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read SND audio data. <br></td></tr>
127<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga3cc352ba4a95b26cd2ca44b0a682804"></a><!-- doxytag: member="audiofile.h::snd_read" ref="ga3cc352ba4a95b26cd2ca44b0a682804" args="(const char *fname, vec &amp;v, int beg, int len)" -->
128bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio.html#ga3cc352ba4a95b26cd2ca44b0a682804">itpp::snd_read</a> (const char *fname, <a class="el" href="classitpp_1_1Vec.html#02e1bb55f60f3c2eb7a020eb1c2cfcf4">vec</a> &amp;v, int beg, int len)</td></tr>
129
130<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read SND audio data. <br></td></tr>
131<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g213f79b0f99b773377ad8d29df4a6fb9"></a><!-- doxytag: member="audiofile.h::snd_write" ref="g213f79b0f99b773377ad8d29df4a6fb9" args="(const char *fname, const vec &amp;v, int rate=8000, SND_Format::data_encoding e=SND_Format::enc_linear16)" -->
132bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio.html#g213f79b0f99b773377ad8d29df4a6fb9">itpp::snd_write</a> (const char *fname, const <a class="el" href="classitpp_1_1Vec.html#02e1bb55f60f3c2eb7a020eb1c2cfcf4">vec</a> &amp;v, int rate=8000, SND_Format::data_encoding e=SND_Format::enc_linear16)</td></tr>
133
134<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write SND audio data. <br></td></tr>
135<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="g5ff9879e380acd29f0af2ff58d58c70d"></a><!-- doxytag: member="audiofile.h::read_endian" ref="g5ff9879e380acd29f0af2ff58d58c70d" args="(std::istream &amp;s, bool switch_endian=false)" -->
136template&lt;typename T &gt; </td></tr>
137<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">T&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__audio.html#g5ff9879e380acd29f0af2ff58d58c70d">itpp::read_endian</a> (std::istream &amp;s, bool switch_endian=false)</td></tr>
138
139<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read binary data and optionally switch endianness. <br></td></tr>
140<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="g157510a8a97cc78fddc2e2304f0aae47"></a><!-- doxytag: member="audiofile.h::write_endian" ref="g157510a8a97cc78fddc2e2304f0aae47" args="(std::ostream &amp;s, T data, bool switch_endian=false)" -->
141template&lt;typename T &gt; </td></tr>
142<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__audio.html#g157510a8a97cc78fddc2e2304f0aae47">itpp::write_endian</a> (std::ostream &amp;s, T data, bool switch_endian=false)</td></tr>
143
144<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write binary data and optionally switch endianness. <br></td></tr>
145</table>
146<hr><a name="_details"></a><h2>Detailed Description</h2>
147Definitions of audio Audio classes and functions.
148<p>
149<dl class="author" compact><dt><b>Author:</b></dt><dd>Tobias Ringstrom and Adam Piatyszek</dd></dl>
150-------------------------------------------------------------------------<p>
151Copyright (C) 1995-2008 (see AUTHORS file for a list of contributors)<p>
152This file is part of IT++ - a C++ library of mathematical, signal processing, speech processing, and communications classes and functions.<p>
153IT++ is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.<p>
154IT++ is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.<p>
155You should have received a copy of the GNU General Public License along with IT++. If not, see &lt;<a href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>&gt;.<p>
156------------------------------------------------------------------------- </div>
157<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:02:13 2009 for mixpp by&nbsp;
158<a href="http://www.doxygen.org/index.html">
159<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
160</body>
161</html>
Note: See TracBrowser for help on using the browser.