Sophie

Sophie

distrib > Fedora > 14 > x86_64 > media > updates > by-pkgid > 6e7a2755bd78c9deedab199b86e675f3 > files > 5696

gnuradio-doc-3.2.2-9.fc14.x86_64.rpm

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>GNU Radio 3.2.2 C++ API: gri_wavfile.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">GNU Radio 3.2.2 C++ API</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('gri__wavfile_8h.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<h1>gri_wavfile.h File Reference</h1>  </div>
</div>
<div class="contents">
<div class="textblock"><code>#include &lt;cstdio&gt;</code><br/>
</div><div class="textblock"><div class="dynheader">
Include dependency graph for gri_wavfile.h:</div>
<div class="dyncontent">
<div class="center"><img src="gri__wavfile_8h__incl.png" border="0" usemap="#gri__wavfile_8h" alt=""/></div>
<map name="gri__wavfile_8h" id="gri__wavfile_8h">
</map>
</div>
</div>
<p><a href="gri__wavfile_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">short int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="gri__wavfile_8h.html#a4049ce9c5f244b2af799636158c84191">gri_wav_read_sample</a> (FILE *fp, int bytes_per_sample)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Read one sample from an open WAV file at the current position.  <a href="#a4049ce9c5f244b2af799636158c84191"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="gri__wavfile_8h.html#a457a6b5e6e4934144dcc6e580f9addd6">gri_wavheader_write</a> (FILE *fp, unsigned int sample_rate, int nchans, int bytes_per_sample)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Write a valid RIFF file header.  <a href="#a457a6b5e6e4934144dcc6e580f9addd6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="gri__wavfile_8h.html#a5359e09acd4dd5538da95b74f3824845">gri_wav_write_sample</a> (FILE *fp, short int sample, int bytes_per_sample)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Write one sample to an open WAV file at the current position.  <a href="#a5359e09acd4dd5538da95b74f3824845"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="gri__wavfile_8h.html#a61f4b77f1e9185a281ec473f8a078a26">gri_wavheader_complete</a> (FILE *fp, unsigned int byte_count)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Complete a WAV header.  <a href="#a61f4b77f1e9185a281ec473f8a078a26"></a><br/></td></tr>
</table>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a4049ce9c5f244b2af799636158c84191"></a><!-- doxytag: member="gri_wavfile.h::gri_wav_read_sample" ref="a4049ce9c5f244b2af799636158c84191" args="(FILE *fp, int bytes_per_sample)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">short int gri_wav_read_sample </td>
          <td>(</td>
          <td class="paramtype">FILE *&#160;</td>
          <td class="paramname"><em>fp</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>bytes_per_sample</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Read one sample from an open WAV file at the current position. </p>
<p>Takes care of endianness. </p>

</div>
</div>
<a class="anchor" id="a5359e09acd4dd5538da95b74f3824845"></a><!-- doxytag: member="gri_wavfile.h::gri_wav_write_sample" ref="a5359e09acd4dd5538da95b74f3824845" args="(FILE *fp, short int sample, int bytes_per_sample)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void gri_wav_write_sample </td>
          <td>(</td>
          <td class="paramtype">FILE *&#160;</td>
          <td class="paramname"><em>fp</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">short int&#160;</td>
          <td class="paramname"><em>sample</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>bytes_per_sample</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Write one sample to an open WAV file at the current position. </p>
<p>Takes care of endianness. </p>

</div>
</div>
<a class="anchor" id="a61f4b77f1e9185a281ec473f8a078a26"></a><!-- doxytag: member="gri_wavfile.h::gri_wavheader_complete" ref="a61f4b77f1e9185a281ec473f8a078a26" args="(FILE *fp, unsigned int byte_count)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> gri_wavheader_complete </td>
          <td>(</td>
          <td class="paramtype">FILE *&#160;</td>
          <td class="paramname"><em>fp</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int&#160;</td>
          <td class="paramname"><em>byte_count</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Complete a WAV header. </p>
<p>Note: The stream position is changed during this function. If anything needs to be written to the WAV file after calling this function (which shouldn't happen), you need to fseek() to the end of the file (or whereever).</p>
<p><code>fp</code> File pointer to an open WAV file with a blank header <code>byte_count</code> Length of all samples written to the file in bytes. </p>

</div>
</div>
<a class="anchor" id="a457a6b5e6e4934144dcc6e580f9addd6"></a><!-- doxytag: member="gri_wavfile.h::gri_wavheader_write" ref="a457a6b5e6e4934144dcc6e580f9addd6" args="(FILE *fp, unsigned int sample_rate, int nchans, int bytes_per_sample)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> gri_wavheader_write </td>
          <td>(</td>
          <td class="paramtype">FILE *&#160;</td>
          <td class="paramname"><em>fp</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int&#160;</td>
          <td class="paramname"><em>sample_rate</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>nchans</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>bytes_per_sample</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Write a valid RIFF file header. </p>
<p>Note: Some header values are kept blank because they're usually not known a-priori (file and chunk lengths). Use <a class="el" href="gri__wavfile_8h.html#a61f4b77f1e9185a281ec473f8a078a26" title="Complete a WAV header.">gri_wavheader_complete()</a> to fill these in. </p>

</div>
</div>
</div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="gri__wavfile_8h.html">gri_wavfile.h</a>      </li>
      <li class="footer">Generated on Thu Feb 17 2011 for GNU Radio 3.2.2 C++ API by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
    </ul>
  </div>

</body>
</html>