<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3"/>
<title>GNU Radio 3.6.4.1 C++ API: gri_wavfile.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<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.6.4.1 C++ API
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3 -->
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){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">
<div class="title">gri_wavfile.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include <<a class="el" href="gr__core__api_8h_source.html">gr_core_api.h</a>></code><br/>
<code>#include <cstdio></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">
<area shape="rect" id="node3" href="gr__core__api_8h.html" title="gr_core_api.h" alt="" coords="14,80,113,107"/><area shape="rect" id="node5" href="attributes_8h.html" title="gruel/attributes.h" alt="" coords="5,155,123,181"/></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 class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a4049ce9c5f244b2af799636158c84191"><td class="memItemLeft" align="right" valign="top">short int </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 class="memdesc:a4049ce9c5f244b2af799636158c84191"><td class="mdescLeft"> </td><td class="mdescRight">Read one sample from an open WAV file at the current position. <a href="#a4049ce9c5f244b2af799636158c84191"></a><br/></td></tr>
<tr class="separator:a4049ce9c5f244b2af799636158c84191"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a457a6b5e6e4934144dcc6e580f9addd6"><td class="memItemLeft" align="right" valign="top">bool </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 class="memdesc:a457a6b5e6e4934144dcc6e580f9addd6"><td class="mdescLeft"> </td><td class="mdescRight">Write a valid RIFF file header. <a href="#a457a6b5e6e4934144dcc6e580f9addd6"></a><br/></td></tr>
<tr class="separator:a457a6b5e6e4934144dcc6e580f9addd6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5359e09acd4dd5538da95b74f3824845"><td class="memItemLeft" align="right" valign="top"><a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a> </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 class="memdesc:a5359e09acd4dd5538da95b74f3824845"><td class="mdescLeft"> </td><td class="mdescRight">Write one sample to an open WAV file at the current position. <a href="#a5359e09acd4dd5538da95b74f3824845"></a><br/></td></tr>
<tr class="separator:a5359e09acd4dd5538da95b74f3824845"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a61f4b77f1e9185a281ec473f8a078a26"><td class="memItemLeft" align="right" valign="top">bool </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 class="memdesc:a61f4b77f1e9185a281ec473f8a078a26"><td class="mdescLeft"> </td><td class="mdescRight">Complete a WAV header. <a href="#a61f4b77f1e9185a281ec473f8a078a26"></a><br/></td></tr>
<tr class="separator:a61f4b77f1e9185a281ec473f8a078a26"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a4049ce9c5f244b2af799636158c84191"></a>
<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 * </td>
<td class="paramname"><em>fp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>bytes_per_sample</em> </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>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a> gri_wav_write_sample </td>
<td>(</td>
<td class="paramtype">FILE * </td>
<td class="paramname"><em>fp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">short int </td>
<td class="paramname"><em>sample</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>bytes_per_sample</em> </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>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool gri_wavheader_complete </td>
<td>(</td>
<td class="paramtype">FILE * </td>
<td class="paramname"><em>fp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>byte_count</em> </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>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">fp</td><td>File pointer to an open WAV file with a blank header </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">byte_count</td><td>Length of all samples written to the file in bytes. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a457a6b5e6e4934144dcc6e580f9addd6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool gri_wavheader_write </td>
<td>(</td>
<td class="paramtype">FILE * </td>
<td class="paramname"><em>fp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>sample_rate</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>nchans</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>bytes_per_sample</em> </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><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_284717b6cb06147531c058220802c6d1.html">gnuradio-core</a></li><li class="navelem"><a class="el" href="dir_7c24473031c549da670035bb20d1e97e.html">src</a></li><li class="navelem"><a class="el" href="dir_84906bae47c76101f1fa015cf813f8a2.html">lib</a></li><li class="navelem"><a class="el" href="dir_4a2470a59e95113f1bc77f5cd957cdf2.html">io</a></li><li class="navelem"><a class="el" href="gri__wavfile_8h.html">gri_wavfile.h</a></li>
<li class="footer">Generated on Fri Apr 19 2013 16:20:35 for GNU Radio 3.6.4.1 C++ API by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.3 </li>
</ul>
</div>
</body>
</html>
