Sophie

Sophie

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

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: gr_wavfile_source.h Source File</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('gr__wavfile__source_8h.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<h1>gr_wavfile_source.h</h1>  </div>
</div>
<div class="contents">
<a href="gr__wavfile__source_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* -*- c++ -*- */</span>
<a name="l00002"></a>00002 <span class="comment">/*</span>
<a name="l00003"></a>00003 <span class="comment"> * Copyright 2004,2008 Free Software Foundation, Inc.</span>
<a name="l00004"></a>00004 <span class="comment"> * </span>
<a name="l00005"></a>00005 <span class="comment"> * This file is part of GNU Radio</span>
<a name="l00006"></a>00006 <span class="comment"> * </span>
<a name="l00007"></a>00007 <span class="comment"> * GNU Radio is free software; you can redistribute it and/or modify</span>
<a name="l00008"></a>00008 <span class="comment"> * it under the terms of the GNU General Public License as published by</span>
<a name="l00009"></a>00009 <span class="comment"> * the Free Software Foundation; either version 3, or (at your option)</span>
<a name="l00010"></a>00010 <span class="comment"> * any later version.</span>
<a name="l00011"></a>00011 <span class="comment"> * </span>
<a name="l00012"></a>00012 <span class="comment"> * GNU Radio is distributed in the hope that it will be useful,</span>
<a name="l00013"></a>00013 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00014"></a>00014 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
<a name="l00015"></a>00015 <span class="comment"> * GNU General Public License for more details.</span>
<a name="l00016"></a>00016 <span class="comment"> * </span>
<a name="l00017"></a>00017 <span class="comment"> * You should have received a copy of the GNU General Public License</span>
<a name="l00018"></a>00018 <span class="comment"> * along with GNU Radio; see the file COPYING.  If not, write to</span>
<a name="l00019"></a>00019 <span class="comment"> * the Free Software Foundation, Inc., 51 Franklin Street,</span>
<a name="l00020"></a>00020 <span class="comment"> * Boston, MA 02110-1301, USA.</span>
<a name="l00021"></a>00021 <span class="comment"> */</span>
<a name="l00022"></a>00022 
<a name="l00023"></a>00023 <span class="preprocessor">#ifndef INCLUDED_GR_WAVFILE_SOURCE_H</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_GR_WAVFILE_SOURCE_H</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include &lt;gr_sync_block.h&gt;</span>
<a name="l00027"></a>00027 
<a name="l00028"></a>00028 <span class="keyword">class </span><a class="code" href="classgr__wavfile__source.html" title="Read stream from a Microsoft PCM (.wav) file, output floats.">gr_wavfile_source</a>;
<a name="l00029"></a>00029 <span class="keyword">typedef</span> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">boost::shared_ptr&lt;gr_wavfile_source&gt;</a> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_wavfile_source_sptr</a>;
<a name="l00030"></a>00030 
<a name="l00031"></a>00031 <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_wavfile_source_sptr</a>
<a name="l00032"></a>00032 <a class="code" href="gr__wavfile__source_8h.html#a03d4e783a767cdcab787ffbf7ef4e99d">gr_make_wavfile_source</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *filename, <span class="keywordtype">bool</span> repeat = <span class="keyword">false</span>);
<a name="l00033"></a>00033 <span class="comment"></span>
<a name="l00034"></a>00034 <span class="comment">/*!</span>
<a name="l00035"></a>00035 <span class="comment"> * \brief Read stream from a Microsoft PCM (.wav) file, output floats</span>
<a name="l00036"></a>00036 <span class="comment"> *</span>
<a name="l00037"></a>00037 <span class="comment"> * Unless otherwise called, values are within [-1;1].</span>
<a name="l00038"></a>00038 <span class="comment"> * Check gr_make_wavfile_source() for extra info.</span>
<a name="l00039"></a>00039 <span class="comment"> *</span>
<a name="l00040"></a>00040 <span class="comment"> * \ingroup source_blk</span>
<a name="l00041"></a>00041 <span class="comment"> */</span>
<a name="l00042"></a>00042 
<a name="l00043"></a><a class="code" href="classgr__wavfile__source.html">00043</a> <span class="keyword">class </span><a class="code" href="classgr__wavfile__source.html" title="Read stream from a Microsoft PCM (.wav) file, output floats.">gr_wavfile_source</a> : <span class="keyword">public</span> <a class="code" href="classgr__sync__block.html" title="synchronous 1:1 input to output with historyOverride work to provide the signal processing implementa...">gr_sync_block</a>
<a name="l00044"></a>00044 {
<a name="l00045"></a>00045 <span class="keyword">private</span>:
<a name="l00046"></a>00046   <span class="keyword">friend</span> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_wavfile_source_sptr</a> <a class="code" href="classgr__wavfile__source.html#ae82a61e2429deb2ec48d9515262ecb44">gr_make_wavfile_source</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *filename,
<a name="l00047"></a>00047                                                               <span class="keywordtype">bool</span> repeat);
<a name="l00048"></a>00048   <a class="code" href="classgr__wavfile__source.html" title="Read stream from a Microsoft PCM (.wav) file, output floats.">gr_wavfile_source</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *filename, <span class="keywordtype">bool</span> repeat);
<a name="l00049"></a>00049 
<a name="l00050"></a>00050   FILE *d_fp;
<a name="l00051"></a>00051   <span class="keywordtype">bool</span> d_repeat;
<a name="l00052"></a>00052   
<a name="l00053"></a>00053   <span class="keywordtype">unsigned</span> d_sample_rate;
<a name="l00054"></a>00054   <span class="keywordtype">int</span> d_nchans;
<a name="l00055"></a>00055   <span class="keywordtype">int</span> d_bytes_per_sample;
<a name="l00056"></a>00056   <span class="keywordtype">int</span> d_first_sample_pos;
<a name="l00057"></a>00057   <span class="keywordtype">unsigned</span> d_samples_per_chan;
<a name="l00058"></a>00058   <span class="keywordtype">unsigned</span> d_sample_idx;
<a name="l00059"></a>00059   <span class="keywordtype">int</span> d_normalize_shift;
<a name="l00060"></a>00060   <span class="keywordtype">int</span> d_normalize_fac;
<a name="l00061"></a>00061   <span class="comment"></span>
<a name="l00062"></a>00062 <span class="comment">  /*!</span>
<a name="l00063"></a>00063 <span class="comment">   * \brief Convert an integer sample value to a float value within [-1;1]</span>
<a name="l00064"></a>00064 <span class="comment">   */</span>
<a name="l00065"></a>00065   <span class="keywordtype">float</span> convert_to_float(<span class="keywordtype">short</span> <span class="keywordtype">int</span> sample);
<a name="l00066"></a>00066 
<a name="l00067"></a>00067 <span class="keyword">public</span>:
<a name="l00068"></a>00068   <a class="code" href="classgr__wavfile__source.html#a27f6016605f5d89ebb79c04ac8086315">~gr_wavfile_source</a> ();
<a name="l00069"></a>00069   
<a name="l00070"></a>00070   <span class="keywordtype">int</span> <a class="code" href="classgr__wavfile__source.html#a222de96b0c15ba344a17f1b37f6d38f6" title="just like gr_block::general_work, only this arranges to call consume_each for you">work</a>(<span class="keywordtype">int</span> noutput_items,
<a name="l00071"></a>00071            <a class="code" href="classstd_1_1vector.html">gr_vector_const_void_star</a> &amp;input_items,
<a name="l00072"></a>00072            <a class="code" href="classstd_1_1vector.html">gr_vector_void_star</a> &amp;output_items);
<a name="l00073"></a>00073 <span class="comment"></span>
<a name="l00074"></a>00074 <span class="comment">  /*!</span>
<a name="l00075"></a>00075 <span class="comment">   * \brief Read the sample rate as specified in the wav file header</span>
<a name="l00076"></a>00076 <span class="comment">   */</span>
<a name="l00077"></a><a class="code" href="classgr__wavfile__source.html#a57ca32ca943d17f86287ad41f4b2baa5">00077</a>   <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classgr__wavfile__source.html#a57ca32ca943d17f86287ad41f4b2baa5" title="Read the sample rate as specified in the wav file header.">sample_rate</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> d_sample_rate; };
<a name="l00078"></a>00078 <span class="comment"></span>
<a name="l00079"></a>00079 <span class="comment">  /*!</span>
<a name="l00080"></a>00080 <span class="comment">   * \brief Return the number of bits per sample as specified in the wav</span>
<a name="l00081"></a>00081 <span class="comment">   * file header. Only 8 or 16 bit are supported here.</span>
<a name="l00082"></a>00082 <span class="comment">   */</span>
<a name="l00083"></a><a class="code" href="classgr__wavfile__source.html#ad0f364a65212fa443b56a23328061908">00083</a>   <span class="keywordtype">int</span> <a class="code" href="classgr__wavfile__source.html#ad0f364a65212fa443b56a23328061908" title="Return the number of bits per sample as specified in the wav file header. Only 8 or 16 bit are suppor...">bits_per_sample</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> d_bytes_per_sample * 8; };
<a name="l00084"></a>00084   <span class="comment"></span>
<a name="l00085"></a>00085 <span class="comment">  /*!</span>
<a name="l00086"></a>00086 <span class="comment">   * \brief Return the number of channels in the wav file as specified in</span>
<a name="l00087"></a>00087 <span class="comment">   * the wav file header. This is also the max number of outputs you can</span>
<a name="l00088"></a>00088 <span class="comment">   * have.</span>
<a name="l00089"></a>00089 <span class="comment">   */</span>
<a name="l00090"></a><a class="code" href="classgr__wavfile__source.html#a80561ba64ab0c3e9e8840a48a0276b83">00090</a>   <span class="keywordtype">int</span> <a class="code" href="classgr__wavfile__source.html#a80561ba64ab0c3e9e8840a48a0276b83" title="Return the number of channels in the wav file as specified in the wav file header. This is also the max number of outputs you can have.">channels</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> d_nchans; };
<a name="l00091"></a>00091 };
<a name="l00092"></a>00092 
<a name="l00093"></a>00093 <span class="preprocessor">#endif </span><span class="comment">/* INCLUDED_GR_WAVFILE_SOURCE_H */</span>
</pre></div></div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="gr__wavfile__source_8h.html">gr_wavfile_source.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>